-
Notifications
You must be signed in to change notification settings - Fork 99
Decom Learn Pages Part 1 #1320
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
Decom Learn Pages Part 1 #1320
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request removes documentation about Moonbeam's Nimbus Consensus Framework and related technical content as part of a docs overhaul. The PR streamlines documentation by eliminating detailed technical pages and replacing linked references with inline text.
Key Changes:
- Removes detailed documentation pages for consensus framework, cross-chain communication, glossary, source code links, and important links
- Simplifies references to the Nimbus Consensus Framework by removing hyperlinks and using inline text instead
- Updates navigation files to reflect removed pages
- Updates LLM-focused documentation files to remove references to deleted content
Reviewed changes
Copilot reviewed 38 out of 42 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
learn/features/consensus.md |
Removed detailed Nimbus Consensus Framework documentation |
learn/features/xchain-plans.md |
Removed cross-chain communication methods documentation |
learn/features/.nav.yml |
Removed navigation links to deleted pages |
learn/features/index.md |
Updated description to remove references to removed content |
learn/platform/glossary.md |
Removed glossary of Polkadot-related terms |
learn/platform/code.md |
Removed source code links page |
learn/platform/links.md |
Removed important links page |
learn/platform/.nav.yml |
Removed navigation links to deleted pages |
learn/platform/why-polkadot.md |
Replaced glossary links with inline text |
learn/platform/vision.md |
Replaced glossary links with inline text |
learn/platform/technology.md |
Replaced glossary links with inline text and removed link to glossary |
learn/platform/networks/moonbeam.md |
Removed link to consensus page |
learn/platform/networks/moonriver.md |
Removed link to consensus page |
learn/core-concepts/consensus-finality.md |
Removed links to consensus page, replaced with inline text |
node-operators/networks/collators/overview.md |
Removed link to consensus page |
tutorials/eth-api/hardhat-start-to-end.md |
Removed glossary link to collators definition |
llms.txt, llms-full.txt, and various llms-files/*.txt |
Updated to remove references to deleted pages |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Automated style guide suggestions (1-14 of 14)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
eshaben
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we want to get rid of the consensus page?
The Consensus and Finality page is sticking around but the Consensus - Nimbus page were are planning to decom. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 33 out of 39 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 33 out of 38 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
eshaben
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any internal links to the glossary need to be updated with the page move?
Checked I think all set ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 33 out of 38 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@themacexpert couple of outstanding comments from my last review |
eshaben
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the learn/.nav.yml should be updated I believe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 33 out of 38 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
Decom some learn pages according to docs overhaul guide.
goes with: papermoonio/moonbeam-mkdocs#283
This pull request primarily updates Moonbeam's documentation to simplify and clarify the explanation of consensus mechanisms, removes outdated or redundant content, and improves navigation. The most significant change is the removal of the detailed page on the Nimbus Consensus Framework, with relevant information now summarized elsewhere. Navigation and descriptions have been updated to reflect these changes.
Documentation Content Updates:
consensus.mdpage about Moonbeam's Nimbus Consensus Framework, including all technical explanations and diagrams.features/index.mdto provide a clearer and more concise overview of Moonbeam's features.Navigation Improvements:
.nav.ymlto remove links to the deleted consensus and cross-chain communication pages, and added a link to the glossary for improved documentation navigation.Content Simplification and Clarification:
consensus-finality.md, removing now-broken links and redundant explanations, and clarifying how collator selection and block production work. [1] [2]Checklist
moonbeam-mkdocsto update redirectsTranslations
Does this PR update a page that also exists on the Chinese docs site? See mapping to confirm.
If Yes, complete the following:
Link to the corresponding CN docs PR: <INSERT_LINK>