Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The PR description states the repository now contains zero em-dashes, but at least Makefile:12 and .github/workflows/contracts-ci.yaml:6 still include em-dashes, so the scope/claim needs to be reconciled.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR streamlines the documentation set by removing a now-obsolete API/indexer integration handoff doc and standardizing prose to eliminate em-dashes, aligning the repository’s published documentation with the existing prose standard.
Changes:
- Delete
docs/api-integration.mdto reduce duplication and remove time-bound integration guidance. - Replace em-dashes with commas/hyphens in key top-level and wiki docs (
README.md,CLAUDE.md, anddocs/wiki/*) without changing technical meaning.
File summaries
| File | Description |
|---|---|
| README.md | Prose punctuation update removing an em-dash in the “Royalty splits” section. |
| CLAUDE.md | Prose punctuation update removing an em-dash in the execution-time fee description. |
| docs/wiki/V2-Changes.md | Replace em-dashes with commas/hyphens across behavioral notes and indexing guidance. |
| docs/wiki/Royalty-Splits.md | Replace em-dashes with commas/hyphens while preserving list structure and invariants. |
| docs/wiki/Home.md | Replace em-dashes with commas/hyphens in the feature summary and fee breakdown list. |
| docs/api-integration.md | Remove outdated/duplicative integration guide entirely. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 1
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Two cleanups, one of them a deletion.
Delete
docs/api-integration.mdThe file names its own audience in its second line: "the team updating the API reader (eosio-contract-api / atomicassets-api filler) for the AtomicMarket V2.0 contract." That team has shipped. The AtomicAssets API 2.0.0 release carries the royalty read layer, the
/atomicmarket/v1/royalties/*endpoints and thelogroy*ledger, and it is deployed on every mainnet.It was also the third copy of the same material. Sections 1 and 4 duplicate the v2.0.0 release notes and
docs/wiki/V2-Changes.md; sections 2 and 3 duplicatedocs/wiki/Royalty-Splits.md, which documents the same three tables, the same settlement math and the same log actions; sections 5 and 6 are derivable from the ABI. Three documents covering one subject is three places to update when royalty behaviour changes, and two of them will be forgotten.10 KB removed, and with it 24 em-dashes.
Remove the em-dashes from documentation
docs/standards/prose.mdbans the em-dash in public repository text. Mid-sentence dashes became commas and the rest became hyphens, acrossREADME.md,CLAUDE.mdand the three wiki pages.docs/api-integration.mddocs/wiki/V2-Changes.mddocs/wiki/Royalty-Splits.mddocs/wiki/Home.mdREADME.mdCLAUDE.mdScope, corrected
An earlier version of this description claimed the repository now has zero em-dashes. That was wrong: it was measured over markdown only. Fourteen remain in code comments, in
Makefile(2),.github/workflows/contracts-ci.yaml(6) andscripts/patch-abi.py(6).They are deliberately not swept here.
prose.mdis explicit that the existing backlog is cleaned opportunistically and never in bulk, meaning the lines a diff already touches for another reason. Documentation was in scope because it is the published, integrator-facing surface; rewriting comments in three files this change does not otherwise touch is exactly the bulk sweep the standard rules out.What was deliberately kept
docs/wiki/stays. It is published (the GitHub wiki is live) and it serves integrators as durable reference, which is a different job from a point-in-time release note. That is a real separation of audience rather than duplication, unlike the file being deleted here.