Repository navigation
docs: quick fixes from docs review - #291
abrahamnash wants to merge 1 commit into
Conversation
Santiagocetran
left a comment
There was a problem hiding this comment.
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.
|
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. |
Quick fixes from the docs review in #. Text only; no code changes.
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# TODOplaceholders.--isOpenSourceis a flag, nottrue/falselocalandsepolia_op_devnetNot 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).