Skip to content

Conversation

@jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Dec 4, 2024

Content

This PR includes significant updates to the About Mithril 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

  • Screenshots are available on this slideshow

Documentation Reorganization:

  • New "Advanced" Section:

    • Added a new "Advanced" section to the documentation to provide detailed insights into Mithril's protocol, phases, certificate chain design, and network architecture. (docs/website/root/mithril/advanced/README.mdx, docs/website/root/mithril/advanced/_category_.json) [1] [2]
  • Updated Links in Glossary and Manuals:

    • Updated multiple links in the glossary and manual files to point to the new "Advanced" section. (docs/website/root/glossary.md, docs/website/root/manual/develop/README.mdx, docs/website/root/manual/develop/nodes/mithril-aggregator.md, docs/website/root/manual/develop/nodes/mithril-client-library-wasm.md, docs/website/root/manual/develop/nodes/mithril-client-library.md, docs/website/root/manual/develop/nodes/mithril-client.md, docs/website/root/manual/develop/nodes/mithril-signer.md, docs/website/root/manual/develop/protocol-simulation.md) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Configuration Updates:

  • Redirects in Docusaurus Config:
    • Added new redirects in the Docusaurus configuration to ensure old URLs point to the new locations in the "Advanced" section. (docs/website/docusaurus.config.js) [1] [2]

Minor Fixes:

  • Stack Exchange Link Update:
    • Updated the Stack Exchange link in the README.md and docusaurus.config.js to use a more accurate search query. (README.md, docs/website/docusaurus.config.js) [1] [2]

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Closes #2154

@jpraynaud jpraynaud self-assigned this Dec 4, 2024
@jpraynaud jpraynaud force-pushed the jpraynaud/2154-update-doc-website-about-mithril branch from 5c6b237 to affb52c Compare December 4, 2024 18:15
@github-actions
Copy link

github-actions bot commented Dec 4, 2024

Test Results

    4 files  ±0     52 suites  ±0   11m 44s ⏱️ +3s
1 425 tests ±0  1 425 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 636 runs  ±0  1 636 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit d60d866. ± Comparison against base commit 490e2c9.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@olgahryniuk olgahryniuk left a comment

Choose a reason for hiding this comment

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

A couple of minor suggestions to consider, please.
Thank you!
Looks great on screenshots

By running 'make update-current' command.
From '0.1.46' to '0.1.47'.
@jpraynaud jpraynaud merged commit 5d1cbea into main Dec 6, 2024
51 of 57 checks passed
@jpraynaud jpraynaud deleted the jpraynaud/2154-update-doc-website-about-mithril branch December 6, 2024 09:53
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

Successfully merging this pull request may close these issues.

Reorganize the About Mithril section in the documentation website

6 participants