docs: reorg & rename top level docs #1455
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ajnavarro
approved these changes
Dec 18, 2023
waymobetta
approved these changes
Dec 18, 2023
zivkovicmilos
approved these changes
Dec 19, 2023
There was a problem hiding this comment.
Looks good 🚀
I think we should probably drop the "tooling" section altogether in the future, as it can get outdated quickly.
@albttx is there a chance we can setup a Netlify preview comment for these docs PRs, but not have the Netlify bot spam each PR?
gfanton
pushed a commit
to moul/gno
that referenced
this pull request
Jan 18, 2024
## Description This PR introduces a small reorg to the docs structure. Our docs follow the [Diataxis](https://diataxis.fr/) framework, but upon further thought I don't believe that we need to or that we should follow the framework 1:1, as it can be too rigid at times. IMHO it is more understandable to have the "Explanation" category renamed to "Concepts" or "Gno Concepts". While this is a minor change, I believe people who are not aware of Diataxis will find "Concepts" more intuitive. This PR also extracts the "Gno Tooling" out of "Explanation", as the category deserves its own spot in the sidebar. EDIT: This PR also resolves the conflict with and modifies the `docs/reference/standard-library.md` file (merged with [gnolang#859](gnolang#859)). <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 - [x] Added references to related issues and PRs - [x] 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a small reorg to the docs structure.
Our docs follow the Diataxis framework, but upon further thought I don't believe that we need to or that we should follow the framework 1:1, as it can be too rigid at times. IMHO it is more understandable to have the "Explanation" category renamed to "Concepts" or "Gno Concepts". While this is a minor change, I believe people who are not aware of Diataxis will find "Concepts" more intuitive.
This PR also extracts the "Gno Tooling" out of "Explanation", as the category deserves its own spot in the sidebar.
EDIT: This PR also resolves the conflict with and modifies the
docs/reference/standard-library.mdfile (merged with #859).Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description