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: official documentation #1046

Merged
merged 74 commits into from
Nov 9, 2023
Merged

Conversation

zivkovicmilos
Copy link
Member

@zivkovicmilos zivkovicmilos commented Aug 10, 2023

Description

This PR introduces the official Gno documentation, which will be hosted at docs.gno.land, using the Docusaurus framework.

As discussed with @moul, the docs are supposed to be framework agnostic, with Docusaurus living in the misc/docusaurus directory.

This documentation also includes work done by @alexiscolin, @leohhhn, @waymobetta, @harry-hov, and the Onbloc team (@dongwon8247 and @r3v4s, migrated from their Developer Portal).
Thank you to everyone who contributed and got us to this point, for the v1 of the docs 🙏

@leohhhn @waymobetta (and DevRels reading this in the future), full ownership of the documentation will be relinquished to you after this PR is merged out.

To run the docs locally:

  • cd misc/docusaurus
  • yarn install
  • yarn start
Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@zivkovicmilos zivkovicmilos added the 📖 documentation Improvements or additions to documentation label Aug 10, 2023
@zivkovicmilos zivkovicmilos self-assigned this Aug 10, 2023
@waymobetta
Copy link
Contributor

Left some very minor observations but otherwise looks awesome. Excited to get this merged so we can build on it 💪

@moul
Copy link
Member

moul commented Aug 12, 2023

Could you please:

  1. Keep the docs/ folder clean, avoiding js/css configurations there. Consider using misc/ for that purpose.
  2. Use a simple docs/ folder instead of docs/gno-docs for clarity.
  3. Ensure user-friendly documentation within docs/, focusing on clear filenames and readable Markdown.
  4. Confirm plans for future documentation testing and how it will be implemented.

Thanks

@albttx
Copy link
Member

albttx commented Aug 14, 2023

Following @moul idea about the name, what do you think about having a directory on the root of the folder named docs.gnolang.com since we already have a docs folder ?

once ready, i'll deploy it :) (don't hesitate to also ping if you need a pre-production on it :) )

Copy link
Member

@moul moul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blocking so I can review before merging, thank you.

@moul moul mentioned this pull request Aug 18, 2023
Copy link
Contributor

@wolkykim wolkykim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great 👍

@zivkovicmilos
Copy link
Member Author

@moul @thehowl

I've started resolving comments on this PR, and will ping you once it's ready for a final glance 🚀

I apologize it's taken this long, somehow something more important has always kept popping up, which took time away from this PR 🙏

@moul @thehowl All conversations should be addressed, please check 🙏

Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9c8f248) 55.95% compared to head (5e9b9d2) 55.92%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1046      +/-   ##
==========================================
- Coverage   55.95%   55.92%   -0.04%     
==========================================
  Files         420      420              
  Lines       65415    65415              
==========================================
- Hits        36606    36583      -23     
- Misses      25951    25970      +19     
- Partials     2858     2862       +4     

see 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@thehowl thehowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving for a speedy merge. Once merged, I'll add to my tasklist to do another thorough review as a PR.

GitHub seems to be complaining about the CODEOWNERS file being invalid; don't know if this arises from manfred trying to move around some groups. Might be worth adding a final newline to the CODEOWNERS file (:shrug:).

Go go go! 🚀 🚀 🚀

docs/explanation/gnovm.md Outdated Show resolved Hide resolved
docs/explanation/gnovm.md Outdated Show resolved Hide resolved
zivkovicmilos and others added 2 commits November 9, 2023 18:31
Co-authored-by: Manfred Touron <94029+moul@users.noreply.github.com>
Co-authored-by: Manfred Touron <94029+moul@users.noreply.github.com>
@moul moul merged commit bc5af65 into gnolang:master Nov 9, 2023
178 checks passed
@zivkovicmilos zivkovicmilos deleted the feature/official-docs branch November 9, 2023 19:21
moul added a commit to moul/gno that referenced this pull request Nov 14, 2023
## Description

This PR introduces the official Gno documentation, which will be hosted
at `docs.gno.land`, using the Docusaurus framework.

As discussed with @moul, the docs are supposed to be framework agnostic,
with Docusaurus living in the `misc/docusaurus` directory.

This documentation also includes work done by @alexiscolin, @leohhhn,
@waymobetta, @harry-hov, and the Onbloc team (@dongwon8247 and @r3v4s,
migrated from their Developer Portal).
Thank you to everyone who contributed and got us to this point, for the
v1 of the docs 🙏

@leohhhn @waymobetta (and DevRels reading this in the future), full
ownership of the documentation will be relinquished to you after this PR
is merged out.

To run the docs locally:
- `cd misc/docusaurus`
- `yarn install`
- `yarn start`

<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>

---------

Co-authored-by: jon roethke <waymobetta@users.noreply.github.com>
Co-authored-by: Blake <104744707+r3v4s@users.noreply.github.com>
Co-authored-by: Dongwon <74406335+dongwon8247@users.noreply.github.com>
Co-authored-by: Leon Hudak <33522493+leohhhn@users.noreply.github.com>
Co-authored-by: Hariom Verma <hariom18599@gmail.com>
Co-authored-by: Alexis Colin <alexis@jaunebleu.co>
Co-authored-by: Manfred Touron <94029+moul@users.noreply.github.com>
Co-authored-by: Morgan <git@howl.moe>
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
Projects
Status: Done
Status: 🚀 Needed for Launch
Status: Done
Archived in project
Development

Successfully merging this pull request may close these issues.