Conversation
Replace the root README command dump with a thin pointer into docs/. Add STANDARD, Overview, Architecture, and Quickstart shells. Correct the release-build command to make build release=1. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Record Makefile test, wasm, WASI, and rustdoc targets. State the GitHub Packages gate and the cargo-only path. Cite KeetaClient and BlockBuilder rustdoc examples. Expand crate-boundary contracts and rejected alternatives. Drop unfilled concept pages from the Overview living map. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Point KeetaClient and BlockBuilder GitHub line links at the Phase 2 substance commit so the citations follow this branch tip. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
cursor
Bot
changed the title
sephynox
marked this pull request as ready for review
September 21, 2026 22:09
Restate asn1 der/rasn as at-least-one to match compile_error!. Keep existing KeetaClient and BlockBuilder examples and add GitHub line links into e2e and user_signing tests. Name Architecture account identities on the account crate rustdoc. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Replace the member roster and Cargo.toml-edge diagram with split forces, illegal states, SSOT homes, and rejected alternatives. Soften Overview so it does not become a second roster. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Replace the ban-list Architecture with a collaboration graph and signed-write interaction path. Add docs/crates notes for the twelve product crates and index them on Overview. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Point Architecture and Overview at Cargo.toml members and the crate note TOC. Drop the Overview version column so crate versions stay in each Cargo.toml. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Point Quickstart at the repository Makefile. Point STANDARD prose and rustdoc example links at Makefile, Cargo.toml, rust-toolchain.toml, or the cited source files in the repository. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Place product-crate architecture under keetanetwork-*/docs/ARCHITECTURE.md with a thin docs/README.md entry. Stub node and ledger get a minimal README only. Overview is the TOC into those paths. Delete docs/crates/. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
The living map lists only pages that exist. STANDARD still states when a future concept page may land. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Replace three-line crate docs entries with purpose, feature and test commands, and an inline rustdoc or test example. Keep node and ledger stub READMEs minimal. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Remove Architecture Example sections and fenced code. Move the stronger x509 builder and WASI seed-to-account snippets onto those crate READMEs. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
Rewrite every product crate Architecture as internal design plus a Mermaid collaboration diagram. Add at least two labeled rustdoc or test examples to each product README. Co-authored-by: Tanveer Wahid <sephynox@users.noreply.github.com>
sephynox
added this pull request to stack #51
September 21, 2026 23:07
Srayman
approved these changes
Sep 21, 2026
|
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
3 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.
Relates to #47. Closes #47. Stacked on #49 /
cursor/docsrs-asn1-ro-repro-9305.Docs markdown only on this tip. Does not reopen #48. Does not change product behavior,
build.rs, tests, CI,Cargo.toml, or A7 rustdoc.Tip:
c85b298468215172d6c1c3890befbc55527f6a3a.Layout
Each product crate holds a useful
docs/README.md(purpose, Quickstart, at least two labeled examples from rustdoc or tests) and a realdocs/ARCHITECTURE.md(internal design, at least one keyword-safe Mermaid diagram, collaboration, positive feature contracts).keetanetwork-nodeandkeetanetwork-ledgerkeep a minimal stubdocs/README.mdonly. Workspacedocs/README.mdis the TOC. Centraldocs/crates/is gone.Architecture and crate docs
docs/ARCHITECTURE.mdkeeps the workspace collaboration graph and the signed-write interaction path.Every product Architecture page now names module responsibilities, draws at least one Mermaid diagram, and states inbound/outbound crate boundaries. Architecture pages carry no fenced rust or JavaScript examples.
docs/STANDARD.mdrequires those Architecture sections and at least two labeled README examples.A7 rustdoc on
keetanetwork-account,keetanetwork-asn1,keetanetwork-block, andkeetanetwork-clientis unchanged on this tip.What landed
README.mdis a thin pointer. Release build ismake build release=1.docs/STANDARD.mddeclares Requirements Language once. Product Architecture must include internal design plus Mermaid. Product READMEs must include at least two labeled examples.docs/README.mdindexes workspace pages and each cratedocs/entry.docs/ARCHITECTURE.mddraws keyword-safe Mermaid ids and walks account, block, vote, client, and host ABI collaboration.docs/QUICKSTART.mdmatches the repository Makefile /rust-toolchain.toml, states the Packages/PAT gate and the cargo-only path, and cites existingKeetaClientandBlockBuilderrustdoc examples.A5-A8 evidence
docs/QUICKSTART.mdtablesdeveloper,build,build release=1,check,test,test-feat,test-all,build-wasm/test-wasm,build-wasi/test-wasi,do-docs/do-docs-ci, andreleaseas publish. Packages:keetanetwork-utils/node-harness/.npmrcplus PATread:packages. Cargo-only:cargo check/cargo buildand tests that do not enablenode-harness.compile_error!gates, andkeetanetwork-client/openapi/keetanet-node.yaml. Crate architecture lives under each cratedocs/.eb68369, preserved through this tip. ExistingKeetaClient/BlockBuilder/VoteBuilder/ wasm examples kept. Client and block crate rustdoc link intotests/e2e.rsanduser_signing.rs. asn1 rustdoc matchescompile_error!at-least-one.Closes #47.TW self-check
docs/ARCHITECTURE.mdholds internal design, Mermaid, and neighbor boundaries. Stub crates have a minimal README only. Quickstart holds the install, test, Packages, and first-use procedure. Zero concept files. Zero node or ledger product Architecture pages.docs/page and every cratedocs/ARCHITECTURE.mdhas Title, Abstract, Purpose, Body, Falsified by, in that order. Root README stays a thin pointer. Product cratedocs/README.mdholds purpose, Quickstart, and at least two examples.docs/STANDARD.md. No per-page repeat. Root README uses plain English.docs/STANDARD.mdwith no TOC. Overview isdocs/README.mdand carries the crate docs TOC. Workspace Architecture isdocs/ARCHITECTURE.md. Crate architecture lives underkeetanetwork-*/docs/.