docs: add comprehensive README documentation for all Cargo packages#314
Closed
m2ux wants to merge 2 commits into
Closed
docs: add comprehensive README documentation for all Cargo packages#314m2ux wants to merge 2 commits into
m2ux wants to merge 2 commits into
Conversation
- Create ARCHITECTURE.md as central index of all packages - Add/update README.md for 24 packages following standardized template - Include API specifications, architecture diagrams, usage examples - Document pallets, primitives, ledger, node, utilities, and tests Packages documented: - Core: runtime, runtime-common, res, node, metadata - Pallets: midnight, midnight-rpc, midnight-system, cnight-observation, cnight-observation-mock, version - Primitives: midnight, ledger, cnight-observation, federated-authority-observation, mainchain-follower - Ledger: ledger, ledger-helpers - Utilities: documented, documented_types, documented_proc_macro, upgrader - Testing: e2e, docs
|
|
gilescope
pushed a commit
that referenced
this pull request
Apr 8, 2026
m2ux
added a commit
that referenced
this pull request
Apr 23, 2026
Signed-off-by: Mike Clay <mike.clay@shielded.io>
m2ux
added a commit
that referenced
this pull request
Apr 23, 2026
Signed-off-by: Mike Clay <mike.clay@shielded.io>
m2ux
added a commit
that referenced
this pull request
May 11, 2026
…ation Signed-off-by: Mike Clay <mike.clay@shielded.io>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds comprehensive README documentation for all Cargo packages following a standardized template.
Changes
Template Structure
Each README includes: overview, API specification, architecture diagram, usage examples, integration details, and testing instructions.
Stats: 25 files changed, 2,875 lines added