From d088829c6d904c5870a63e05cc789065c130ee04 Mon Sep 17 00:00:00 2001 From: gamarin Date: Mon, 18 Nov 2019 16:08:10 +0100 Subject: [PATCH] update docs readme --- CONTRIBUTING.md | 7 +++---- docs/DOCS_README.md | 9 ++++++++- docs/core/transactions.md | 2 +- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07b8b3d9405..139c9a4576e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,10 +92,9 @@ All PRs require two Reviews before merge (except docs changes, or variable name- If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. -- If your change relates to the core SDK (baseapp, store, ...), please update the docs/cosmos-hub folder and possibly the docs/spec folder. -- If your changes relate specifically to the gaia application (not including modules), please modify the docs/cosmos-hub folder. -- If your changes relate to a module, please update the module's spec in docs/spec. If the module is used by gaia, you might also need to modify docs/cosmos-hub. -- If your changes relate to the core of the CLI or Light-client (not specifically to module's CLI/Rest), please modify the docs/clients folder. +- If your change relates to the core SDK (baseapp, store, ...), please update the `docs/basics/`, `docs/core/` and/or `docs/building-modules/` folders. +- If your changes relate to the core of the CLI or Light-client (not specifically to module's CLI/Rest), please modify the `docs/interfaces/` folder. +- If your changes relate to a module, please update the module's spec in `x/moduleName/docs/spec/`. ## Forking diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md index c2b7e86ea40..96986bef803 100644 --- a/docs/DOCS_README.md +++ b/docs/DOCS_README.md @@ -1,6 +1,13 @@ # Updating the docs -If you want to open a PR on the Cosmos SDK to update the documentation, please follow the guidelines in the [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md) +If you want to open a PR on the Cosmos SDK to update the documentation, please follow the guidelines in the [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md#updating-documentation) + +## Translating + +- Docs translations live in a `docs/country-code/` folder, where `country-code` stands for the country code of the language used (`cn` for Chinese, `kr` for Korea, `fr` for France, ...). +- Always translate content living on `master`. +- Only content under `/docs/intro/`, `/docs/basics/`, `/docs/core/`, `/docs/building-modules/` and `docs/interfaces` needs to be translated, as well as `docs/README.md`. It is also nice (but not mandatory) to translate `/docs/spec/`. +- Specify the release/tag of the translation in the README of your translation folder. Update the release/tag each time you update the translation. ## Docs Build Workflow diff --git a/docs/core/transactions.md b/docs/core/transactions.md index 1feeb473f43..b3670f28333 100644 --- a/docs/core/transactions.md +++ b/docs/core/transactions.md @@ -49,7 +49,7 @@ When users interact with the application's interfaces, they invoke the underlyin **`Message`s** are module-specific objects that trigger state transitions within the scope of the module they belong to. Module developers define the `message`s for their module by implementing the `Msg` interface, and also define a [`Handler`](../building-modules/handler.md) to process them. -+++ https://github.com/cosmos/cosmos-sdk/blob/master/types/tx_msg.go#L10-L31 ++++ https://github.com/cosmos/cosmos-sdk/blob/master/types/tx_msg.go#L8-L29 `Message`s in a module are typically defined in a `msgs.go` file (though not always), and one handler with multiple functions to handle each of the module's `message`s is defined in a `handler.go` file.