Docs: reorganize user manual section in docs website #2102
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
jpraynaud
changed the title
jpraynaud
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
jpraynaud
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
jpraynaud
force-pushed
the
jpraynaud/2101-update-doc-website-user-manual
branch
from
2471c74
to
9a6cdfd
Compare
jpraynaud
requested review from
rezabaram,
Alenar,
sfauvel,
olgahryniuk,
dlachaume and
oduameh
jpraynaud
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
jpraynaud
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
olgahryniuk
reviewed
Nov 11, 2024
| @@ -61,7 +61,7 @@ Switch to the desired branch/tag: | |||
|
|
|||
| ```bash | |||
| # Replace **YOUR_BUILD_BRANCH_OR_TAG** with the appropriate branch or tag name | |||
| # Please refer to the **Build from** column of the **Mithril networks** table above | |||
| # Please refer to the **Build from** column of the **Mithril networks** section | |||
There was a problem hiding this comment.
There are many mentions of this note throughout the guide. I changed the 'table' to 'section'. However, I think it's best to update these notes to say 'Network configurations' and link to a newly created section.
jpraynaud
force-pushed
the
jpraynaud/2101-update-doc-website-user-manual
branch
from
751695f
to
77206dc
Compare
jpraynaud
force-pushed
the
jpraynaud/2101-update-doc-website-user-manual
branch
from
77206dc
to
5b5321e
Compare
jpraynaud
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
jpraynaud
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
From '0.1.44' to '0.1.45'.
jpraynaud
force-pushed
the
jpraynaud/2101-update-doc-website-user-manual
branch
from
5b5321e
to
6e6c776
Compare
jpraynaud
temporarily deployed
to
testing-preview
GitHub Actions
Inactive
jpraynaud
temporarily deployed
to
testing-sanchonet
GitHub Actions
Inactive
olgahryniuk
approved these changes
Nov 12, 2024
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.
Content
This PR includes significant updates to the user manual documentation for Mithril, including new sections and reorganized content. The changes aim to improve the clarity and accessibility of the information for developers and users.
Note
Documentation Updates:
docs/website/docusaurus.config.js)Developsection with a README and category configuration. (docs/website/root/manual/develop/README.mdx,docs/website/root/manual/develop/_category_.json) [1] [2]docs/website/root/manual/develop/nodes/mithril-signer.md,docs/website/root/manual/develop/protocol-simulation.md,docs/website/root/manual/develop/references.md,docs/website/root/manual/develop/run-mithril-devnet.md) [1] [2] [3] [4]Dependency Updates:
package.jsonandpackage-lock.jsonto include new plugins and update the version. (docs/website/package.json,docs/website/package-lock.json) [1] [2]Structural Changes:
Developer Docscategory configuration. (docs/website/root/manual/developer-docs/_category_.json)Getting Startedsection with a README and category configuration. (docs/website/root/manual/getting-started/README.mdx,docs/website/root/manual/getting-started/_category_.json) [1] [2]Bootstrap a Cardano nodedocumentation to adjust the sidebar position and remove theMithril networksnote. (docs/website/root/manual/getting-started/bootstrap-cardano-node.md) [1] [2]Network configurationsdocumentation file. (docs/website/root/manual/getting-started/network-configurations.md)Pre-submit checklist
Issue(s)
Relates to #2101