Skip to content

docs: fix broken install command, unrunnable examples, and stale repo URLs - #11

Merged
AetherAI3 merged 1 commit into
mainfrom
docs/readme-accuracy-and-install-fix
Aug 14, 2026
Merged

docs: fix broken install command, unrunnable examples, and stale repo URLs#11
AetherAI3 merged 1 commit into
mainfrom
docs/readme-accuracy-and-install-fix

Conversation

@AetherAI3

Copy link
Copy Markdown
Owner

The documented install command didn't work, and two of the three Python examples crashed when run as written. No library code changed — 137 tests pass.

pip install aether-protocol-c never worked

The package has never been published to PyPI, so the first command a new visitor runs failed:

ERROR: No matching distribution found for aether-protocol-c

It appeared in 4 places across the README and whitepaper. Installs now point at the git URL (verified working, unauthenticated), with an explicit note that PyPI isn't live yet. dist/ already holds a built wheel and sdist, so this can revert to the short form as soon as a release is published.

Two examples couldn't be copy-pasted

  • Three-phase protocol — all three create_and_sign calls were written as (...), showing no arguments whatsoever. It also imported get_seed without using it, and claimed each phase "lands in the audit log" when create_and_sign never touches the log — callers must call AuditLog.append_* themselves. Now shows the real flow: full arguments, three independent seeds, broker attestation signing, and explicit log appends.
  • Batch commit — used {...} as a placeholder. That's valid Python (a set containing Ellipsis), so it parsed and then died at runtime with AttributeError: 'set' object has no attribute 'keys' — which reads like a library bug, not a placeholder. Now uses real payloads.

Every Python block in README.md and docs/ was extracted and executed against the package: 5/5 pass. The full documented CLI surface was exercised too (info, seed, init, demo, commit, logs, verify), including the tamper-detection contract — a modified envelope correctly exits nonzero.

Stale canonical URLs

18 links pointed at DBarr3/protocol-c, which 301-redirects to the current AetherAI3/PROTOCOL-C. Updated across CITATION.cff, CONTRIBUTING.md, SECURITY.md, docs/WHITEPAPER.md, pyproject.toml, and the README citation block so links and package metadata resolve directly instead of through a redirect.

Follow-ups (not in this PR)

  • Publish to PyPI + cut v0.1.0 — there are currently no releases or tags.
  • Two public backlinks still point at the old slug (the AETHER-PROTOCOL-P README and the AETHER-CLOUD protocol-c.html page); both live in other repos.

… URLs

The documented install command did not work. `pip install aether-protocol-c`
resolves to nothing — the package has never been published to PyPI — so the
first command in the README failed for every new visitor:

    ERROR: No matching distribution found for aether-protocol-c

Point installs at the git URL, which is verified working, and state plainly
that PyPI is not live yet. Build artifacts already exist in dist/; when the
first release is published this can go back to the short form.

Two code samples could not be run as written:

- The three-phase example passed `(...)` to all three `create_and_sign`
  calls, so it showed no arguments at all, imported `get_seed` without
  using it, and claimed each phase "lands in the audit log" when
  `create_and_sign` never writes to the log — callers must invoke
  `AuditLog.append_*` themselves. Replaced with the full flow: real
  arguments, all three independent seeds, broker attestation signing, and
  explicit log appends.
- The batch example used `{...}` as a placeholder. That is valid Python (a
  set containing Ellipsis), so it parsed and then failed at runtime with
  `AttributeError: 'set' object has no attribute 'keys'`, which reads like
  a library bug rather than a placeholder. Replaced with real payloads.

Every Python block in README.md and docs/ now executes successfully against
the package (5/5), verified by extracting and running each one.

Repo URLs pointed at DBarr3/protocol-c, which 301-redirects to the current
canonical AetherAI3/PROTOCOL-C. Updated across CITATION.cff, CONTRIBUTING.md,
SECURITY.md, docs/WHITEPAPER.md, pyproject.toml, and the README citation so
links and package metadata resolve directly.

No library code changed; 137 tests pass.
@AetherAI3
AetherAI3 merged commit 062362a into main Aug 14, 2026
5 checks passed
@AetherAI3
AetherAI3 deleted the docs/readme-accuracy-and-install-fix branch August 14, 2026 20:22
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.

1 participant