Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
4 tasks
jaybxyz opened this issue Nov 4, 2021 · 1 comment
Open
4 tasks
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jaybxyz
Copy link
Contributor

jaybxyz commented Nov 4, 2021

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

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@jaybxyz jaybxyz added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2021
@barriebyron
Copy link
Contributor

barriebyron commented Nov 4, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants