Skip to content

docs: fix quickstart flags and Python version - #1

Open
mosesman831 wants to merge 1 commit into
mainfrom
devin/1791639015-docs-fix
Open

mosesman831 wants to merge 1 commit into
mainfrom
devin/1791639015-docs-fix

Conversation

@mosesman831

Copy link
Copy Markdown
Contributor

Summary

Three flag fixes and a version correction in the quickstart, all verified against the real CLI:

  • source register takes --source, not --file.
  • import commit requires --expected-revision — it compare-and-swaps against the stored revision and fails REQUEST_INVALID without it (shown as 1, since source.register produces revision 1).
  • init requires --trust (whose heads may pin only genesis-zero heads) and --principal naming a configured admin, plus --request-id.
  • Python requirement relaxed from ≥3.11 to ≥3.10 — nothing pins higher (no pyproject.toml) and the parity suite passes 8/8 on 3.10.12.
  • Notes that the JSON inputs are operator-maintained (fixture shapes live in test/fixture.ts), that npm run build:native is required by serve (the peercred helper provides caller identity), and that --require ANCHORED needs trust heads pinning the live audit head and source cuts — INTEGRITY/RECONSTRUCTION don't.

Verified end-to-end on a fresh VM with the fixture materialized from test/fixture.ts: init → serve → source register --source → import stage → import commit --expected-revision 1 → export → verify --require ANCHORED returning accepted:true. npm test passes (72/72).

Link to Devin session: https://app.devin.ai/sessions/5fcebb20f9a0438daaa48abc90b25087
Open in Devin Desktop: https://app.devin.ai/desktop/session/5fcebb20f9a0438daaa48abc90b25087?variant=devin
Requested by: @mosesman831

- source register takes --source, not --file.
- import commit requires --expected-revision (compare-and-swap; fails
  REQUEST_INVALID without it).
- init requires --trust (genesis-zero head pins only) and --principal
  naming a configured admin; --request-id was also missing.
- Python parity suite passes on 3.10, so relax the stated >=3.11 to >=3.10
  (no pyproject pins otherwise).
- Note native/peercred is required by serve, that the JSON inputs are
  operator-maintained (fixture shapes in test/fixture.ts), and that
  ANCHORED needs trust heads pinning the live chain heads.
Copilot AI balanced review requested due to automatic review settings October 10, 2026 13:33
@devin-ai-integration

Copy link
Copy Markdown

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants