Skip to content

docs: quick fixes from docs review - #291

Closed
abrahamnash wants to merge 1 commit into
developfrom
docs-quick-fixes
Closed

abrahamnash wants to merge 1 commit into
developfrom
docs-quick-fixes

Conversation

@abrahamnash

Copy link
Copy Markdown
Member

Quick fixes from the docs review in #. Text only; no code changes.

Prepared with an AI agent (Claude) and checked against the code on develop. Please review with that in mind.

  • getting-started.md: a note that the guide describes DevNet 2.0 (commit/reveal steps aren't on today's DevNet 1.0); GI 2 status; softened "fully verifiable" claims; current Telegram link
  • Wrong commands replaced with the real ones (checked against the CLI source): register-request, show-registration-request, update-manifest-request, create-genesis-model, submit-genesis-model, get-registry-fee, in roles/model-owner.md, manifest.md and workflows/model-workflow.md. Removes three # TODO placeholders.
  • --isOpenSource is a flag, not true/false
  • Network lists show only local and sepolia_op_devnet
  • "DAO" → DIN-Representative (7 places)
  • manifest.md: describes what actually happens when the manifest is missing
  • setup.md: note box moved out of the code block
  • CONTRIBUTING.md: the setup guide is a link, not a command
  • GOOD_FIRST_ISSUES.md: points to the live label; marks the DP review as completed
  • whitepaper-summary.md: white paper link points to the new PDF

Not included (needs a maintainer decision): the install instructions in setup.md, DEVELOPMENT_SETUP.md, CODE_STANDARDS.md, and the "Infinite Zero" naming (handled with the InfiniteZero rename).

@abrahamnash
abrahamnash requested a review from umeradl October 27, 2026 22:14
@abrahamnash abrahamnash added the documentation Improvements or additions to documentation label Oct 27, 2026

@Santiagocetran Santiagocetran left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks, Abraham. Reviewed 52f9282 against develop 954fbf8 and #290. Two documented paths still need correction:

1. P2: Qualify the CID-only registration route.

The registration example offers --manifestCID. In the current implementation, supplying a CID skips initialization of dinregistry_contract, which the subsequent fee lookup accesses. This is an existing CLI defect in the newly documented path.

Please document the manifest-file route instead, or clearly mark the CID shortcut as unavailable pending a separately tested fix. The manifest-file route avoids this particular initialization defect; I have not verified it end to end. This finding concerns registration, not the manifest-update command.

2. P2: Qualify the default-manifest recovery instructions.

The new note correctly says genesis creation stops when the manifest is missing, but then promises that cache-default-artifacts downloads it. That helper requires an existing task directory and a configured default_manifest. The bundled sepolia_op_devnet configuration has no such entry.

Please explain the preparation prerequisites and limit the caching instruction to networks with configured default artifacts. Otherwise, describe explicit manifest preparation. A documentation correction is sufficient; no CLI implementation expansion is requested.

Small wording correction: my-requests lists pending requests by default. To promise “all your requests,” include --include-processed, or change the wording to “pending requests.”

Please also coordinate the nine overlapping files with #294 so the corrections are preserved together. CI passed for this head/base pair, but that doesn’t verify these command paths. This review is based on source inspection and observed CI, not a live registration or IPFS run.

@abrahamnash

Copy link
Copy Markdown
Member Author

Closing in favour of #294, which covers more of #290. The fixes from this PR that #294 doesn't have yet are listed there, and @Santiagocetran's corrections apply to both. Thanks for the careful review, Santiago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants