Skip to content

Reference Documentation

How to use the Cosmos Cash Reference Documentation.

Introduction

This section contains Reference documentation for Cosmos Cash. Reference Documentation is intended to be information-oriented. Content must allow the reader to easily navigate the content and use the content in conjunction with the code.

This documentation describes the machinery, for example, classes, functions, interfaces, parameters, and so on.

For further information please see the ADR relating to the documentation structure.

Contributing

  • The content must be dry, clear, and terse in style.
  • All documentation should be written following Google Documentation Best Practice
  • Generate as much documentation as possible from the code.
  • Raise a PR for all documentation changes

Layout

Reference Documentation will come in various forms:

  • Architecture diagrams - Diagrams must be in SVG format so that the diagrams can remain crisp and clear at any resolution or size, stored in GitHub, and version controlled.
  • Module specifications and designs - By convention, module documentation in the Cosmos SDK is stored with the module itself. However, we propose that the easiest way for a new user to find documentation is to store the documentation at the root docs folder. To accomodate this module, the documentation will follow the existing convention, but the content will be reference from this section.
  • Code-level documentation - The text that is part of the code and is used to auto-generate the documentation from the code.
  • API reference - Including REST and gRPC endpoints.
  • Glossary - a dictionary of domain-relevant terms. This glossary can be used in conjunction with the Cosmos Network Glossary.

Reference