Skip to content

docs: fix broken install path, wrong commands and stale status in participant guides #290

Open

Description

@abrahamnash

Note: this review was produced by an AI agent (Claude), checking the docs against the code on develop on 27 October 2026. It may be missing context: some items may already be resolved, in progress elsewhere, or deliberately left as they are. If so, please comment and we'll tick them off or drop them.

Most of these block a newcomer from getting started.

Blocks newcomers

  • Documentation/public/setup.md:34-42: both install options fail. Option A downloads dincli-0.1.0 from main, which only has 0.2.0. Option B installs from dist/, which has no pyproject.toml (pip: "neither 'setup.py' nor 'pyproject.toml' found"). Coordinate with the install-guide issue.
  • Documentation/public/getting-started.md: says "Global Iteration 2 in progress" (line 62), but GI 2 stopped at registration. It teaches DevNet 2.0 commit/reveal steps (lines 360-384), and the live DevNet 1.0 contracts have no commit/reveal functions. Add a clear note on which network the guide is for.
  • Commands that don't exist, with the real ones:
    • model-owner registry request-registration → task model-owner register-request (roles/model-owner.md:87, # TODO)
    • model-owner registry show-request → task model-owner show-registration-request (roles/model-owner.md:103, # TODO)
    • model-owner registry request-manifest-update → task model-owner update-manifest-request (roles/model-owner.md:115, # TODO)
    • task model-owner update-manifest → task model-owner update-manifest-request (manifest.md:124)
    • task model-owner register → task model-owner register-request (workflows/model-workflow.md:200)
    • model-owner model create-genesis and task model-owner create-genesis → model-owner model create-genesis-model (manifest.md:22, 42)
    • model-owner model submit-genesis → model-owner model submit-genesis-model (roles/model-owner.md:146)
    • system get-fees → system get-registry-fee (roles/model-owner.md:60)
  • sepolia_devnet and mainnet are listed as network options (setup.md:73, cli-reference.md:13 and 38, roles/clients.md:19). din_info.json has no sepolia_devnet entry and mainnet only has placeholder addresses, so both fail. List only local and sepolia_op_devnet until they exist.

Stale or misleading

  • Developer/GOOD_FIRST_ISSUES.md (linked from the README) lists the DP review starter task as open; its own task file marks it completed in PR docs(dp): governance review of DevNet DP baseline (starter task) #89. Replace the list with a link to the good first issue label, or update it.
  • getting-started.md contradicts itself: line 98 says trust rests on "cryptographic and economic enforcement" and line 92 says the system is "fully verifiable end-to-end", while line 178 says economic and reward mechanisms are still under development.
  • README.md:24 says "Only anonymised, encrypted patterns join the network". Client model updates are uploaded unencrypted (with optional DP); only the auditors' test data is encrypted. PR docs: refresh README, add CITATION.cff and impact page #280 fixes this wording.
  • "DAO" approval: roles/model-owner.md:96, 108 and 119; "later DIN-DAO": workflows/din-workflow.md:5 and workflows/model-workflow.md:8. Approvals are by the DIN-Representative, and the DAO is deferred to post-mainnet.
  • Naming: "Infinite Zero" (14 times) vs "InfiniteZero" (9 times) across public docs; sepolia-op-devnet (getting-started.md:11, 39, 43, 134) vs the real value sepolia_op_devnet.
  • Old Telegram invite link in getting-started.md:190 (t.me/+I4Tl7foCVwwwM2Vk). Replace it with the current link, t.me/+h46VS3AnO384ZGI8.

Thin or unclear

  • Developer/DEVELOPMENT_SETUP.md: add the Python version (3.12+), Foundry install, how to run the Solidity and Python tests, and links to Documentation/technical/testing/.
  • Developer/CODE_STANDARDS.md is empty but linked from Developer/README.md.
  • Developer/CONTRIBUTING.md:15: a file path sits inside a bash block as if it were a command.
  • setup.md:76-77: a [!NOTE] callout sits inside a code block and renders as raw text.
  • Typos in workflows/model-workflow.md:195 ("manisfest") and 197 ("Protocolat", "Model Owner then register").

Activity

  1. Abidoyesimze commented on Oct 28, 2026

    @Abidoyesimze
    Collaborator

    Starting on this one - will work through the full checklist and open a PR. Will comment back if anything in it turns out to already be resolved or in progress elsewhere.

  2. Abidoyesimze commented on Oct 28, 2026

    @Abidoyesimze
    Collaborator

    Opened #294 covering the full checklist above.

    A couple of notes on scope:

    Everything else in the checklist is addressed and verified against current develop (commands checked against the actual registered CLI, network options checked against din_info.json, etc.) — details are in the PR description.

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions