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

Use godoc/gnodoc for displaying docs on p/demo packages #1806

Open
leohhhn opened this issue Mar 20, 2024 · 1 comment
Open

Use godoc/gnodoc for displaying docs on p/demo packages #1806

leohhhn opened this issue Mar 20, 2024 · 1 comment
Assignees

Comments

@leohhhn
Copy link
Contributor

leohhhn commented Mar 20, 2024

Description

As we discussed in a call today, we should keep on-chain package docs within package/realm code itself. This way, documentation/usage instructions for packages can be on-chain, and displayed with a version of godoc, while the Official Documentation can document Gno.land concepts, references, etc more generally.

I suggest we remove package-specific docs from the Official docs, such as AVL tree docs, and simply point users to use godoc/onchain comments to learn how a package works. We can leave the Packages/Realms page to document the ideas and concepts, possibly include a few examples, and point people to the actual on-chain code.

This will:

  • Help with transparency
  • Minimize Official docs footprint and maintenance efforts
  • Force developers to write godoc instructions/docs within their code.

cc @thehowl @moul

@thehowl
Copy link
Member

thehowl commented Apr 11, 2024

#522

@thehowl thehowl self-assigned this Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants