Skip to content

Conversation

@themacexpert
Copy link
Contributor

@themacexpert themacexpert commented Dec 5, 2025

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:

  • Removed the detailed consensus.md page about Moonbeam's Nimbus Consensus Framework, including all technical explanations and diagrams.
  • Updated the description in features/index.md to provide a clearer and more concise overview of Moonbeam's features.

Navigation Improvements:

  • Updated .nav.yml to 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:

  • Simplified references to the Nimbus Consensus Framework in consensus-finality.md, removing now-broken links and redundant explanations, and clarifying how collator selection and block production work. [1] [2]

Checklist

  • Added a label 🏷️ to this PR
  • Ran my changes through Grammarly
  • Added a disclaimer if required
  • If pages were moved, opened a corresponding PR in moonbeam-mkdocs to update redirects

Translations

Does this PR update a page that also exists on the Chinese docs site? See mapping to confirm.

  • Yes
  • No

If Yes, complete the following:

  • Opened a PR on the Chinese docs repo for the corresponding page
  • Updated images, snippets, or variables if they were moved, renamed, or deleted

Link to the corresponding CN docs PR: <INSERT_LINK>

@themacexpert themacexpert requested a review from a team as a code owner December 5, 2025 22:21
Copilot AI review requested due to automatic review settings December 5, 2025 22:21
Copy link
Contributor

Copilot AI left a 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.

Copy link
Contributor

@github-actions github-actions bot left a 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)

themacexpert and others added 6 commits December 5, 2025 15:39
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>
Copy link
Contributor

@eshaben eshaben left a 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?

@themacexpert
Copy link
Contributor Author

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.

Copy link
Contributor

Copilot AI left a 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.

eshaben
eshaben previously approved these changes Dec 16, 2025
Copy link
Contributor

Copilot AI left a 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.

Copy link
Contributor

@eshaben eshaben left a 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?

@themacexpert
Copy link
Contributor Author

any internal links to the glossary need to be updated with the page move?

Checked I think all set !

Copy link
Contributor

Copilot AI left a 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
Copy link
Contributor

eshaben commented Dec 22, 2025

@themacexpert couple of outstanding comments from my last review

Copy link
Contributor

@eshaben eshaben left a 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

Copy link
Contributor

Copilot AI left a 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 themacexpert requested a review from eshaben December 22, 2025 19:42
@eshaben eshaben merged commit cbf1b33 into master Dec 22, 2025
9 checks passed
@eshaben eshaben deleted the themacexpert/learnpart1 branch December 22, 2025 19:44
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.

3 participants