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

Documentation #28

Closed
blockcreators opened this issue Jun 30, 2021 · 4 comments
Closed

Documentation #28

blockcreators opened this issue Jun 30, 2021 · 4 comments
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@blockcreators
Copy link

blockcreators commented Jun 30, 2021

So currently as far as I can see, the documentation is mainly in the readme file and scattered elsewhere.
People initially are hit with the readme, but might want to see the other areas of the project.
So it might be better to split the documentation into specific modules.

How about set up docs.gnolang.com as the documentation site and also put the bulk of the current documentation there.
You could use gitbook (I've used it before and it seems good, and free to use for opensource projects like this)

Let me know if I can help!

@jaekwon
Copy link
Contributor

jaekwon commented Aug 27, 2021

There isn't much documentation yet, but hosting sounds good at some point. What's your experience/expertise?

@darksoulcrypto
Copy link

VuePress?

@moul moul added the 📖 documentation Improvements or additions to documentation label May 10, 2022
@moul
Copy link
Member

moul commented May 10, 2022

With things like https://gno.land/r/boards?help, we could keep the focus on making the system generating automatic documentation as much as possible.

There are various enhancements we can do:

  • support function-level comments
  • support package-level comments
  • generate various machine-readable formats (swagger?)
  • support comments-based "examples" -> could be done in the package-level comments

And other topics which are not related to the code, such as user doc etc:

  • continue improving and using r/boards:gnolang?
  • ask help from the community to maintain some good references, etc?

@moul moul added good first issue Good for newcomers help wanted Extra attention is needed labels May 10, 2022
@moul
Copy link
Member

moul commented Sep 5, 2023

closing since very old and documentation was updated a lot since and has ongoing improvements too.

@moul moul closed this as completed Sep 5, 2023
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
Archived in project
Development

No branches or pull requests

4 participants