tendermint / farming

Farming is a Cosmos SDK module that implements farming functionality
Apache License 2.0
20 stars 15 forks source link

feat: build site for documentation for better developer experience #213

Open jaybxyz opened 3 years ago

jaybxyz commented 3 years ago

Summary

This issue proposes to set up a way to generate documentation contents from the code as suggested from @barriebyron in this comment. This is not an urgent task to take care of, but something that is worthwhile to be discussed because I think it is useful for the community in the long term.

Proposal

Starport has this site for documentation up and running generating the contents from the code. We can reference the project to see if we can achieve the same. We can maybe combine all the modules that we build liquidity, budget, farming, and fundraising in one site if possible.

References

For Admin Use

barriebyron commented 3 years ago

see the Starport contributing guidelines for updating command lines https://github.com/tendermint/starport/blob/develop/contributing.md

code-generated command line docs are so awesome

Starport CLI reference, navigate to the ./starport/cmd package and update the documentation of the related command from its cobra.Command struct. The CLI docs are automatically generated, so do not make changes to docs/cli/index.md.