alexmandClaude
8c8b51cc3f
- Add tools/validate.py: validates packages, and with --correction runs proposed corrections through the gate against a package without writing anything (spec/11 §11.4). The gate now refuses a proposal that fails the correction schema, rule correction.schema. - tools/load.py validates every package before loading, and with --bundle --built-from builds a scienting-bundle/1 with the FTS5 search index and bundle_meta (spec/13 §13.5). Search rows are defined per unit (sentence, cell, equation outside a sentence, figure-text) with the parent kind as context. - Roster keys carry a role, and a key with the role owner may revoke any receipt (spec/08 §8.7, spec/20); roster schema, store table and the fixture roster updated. The checker signs a trial revocation to prove the rule both ways. - A qa: receipt raises the nodes it sampled except those in its errors (spec/08 §8.2); the example paper's fidelity counts become 27 F3, 13 F2, 4 F1 and 1 F0. - The destination chooses the keyed scheme, not the text policy: hmac-team between the team's machines, hkdf-pages outside the team (spec/05 §5.8, spec/12 §12.5). - A TextQuoteSelector must repeat the anchor's plain quote and is absent for hashed or keyed anchors (spec/18 §18.3). - Add fixtures/records/suspect.json, a scienting-suspect/1 record. - Oracle: hashes are kept incrementally and checked after every correction against a full recomputation; load and write refuse unsafe manifest paths; Ed25519, HKDF and schema validation come from the cryptography and jsonschema packages; canonical JSON uses the built-in encoder with an exact RFC 8785 fallback. - The tools need Python 3.14 with cryptography and jsonschema; the py310 CI environment is dropped and the workflow runs the default only. - Resolve every [CHECK] note in the docs, READMEs and context; add CONTRIBUTING.md; every tool answers --help and refuses unknown options. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
34 lines
2.4 KiB
Markdown
34 lines
2.4 KiB
Markdown
# Guides
|
|
|
|
These guides explain manuspec to someone meeting it for the first time.
|
|
They serve three readers: a newcomer who has not seen the problem before, an implementer who will write a reader, writer, converter or checker, and an expert who knows the neighboring standards.
|
|
The [specification](../spec/README.md) says exactly what each format is.
|
|
The guides say what each format is for, with examples drawn from the fixtures.
|
|
|
|
| Guide | For |
|
|
| --- | --- |
|
|
| [Overview](overview.md) | What manuspec is, who it serves, and how its parts fit together. |
|
|
| [Concepts](concepts.md) | The ideas behind the formats, one at a time, each with a real example. |
|
|
| [Walkthrough](walkthrough.md) | One paper, from a flawed first reading to a corrected, reviewed and signed document. |
|
|
| [Examples](examples.md) | Things to run: checking hashes by hand, reading a package with a few lines of Python, querying a database. |
|
|
| [Rationale](rationale.md) | Why the formats look the way they do, and the questions they leave open. |
|
|
| [Comparison](comparison.md) | How manuspec compares with JATS, TEI, W3C Web Annotation and other schemas. |
|
|
| [*FAQ*](faq.md) | Short answers to the questions people ask first. |
|
|
| [Glossary](glossary.md) | Every term, in a sentence. |
|
|
|
|
## Reading orders
|
|
|
|
**Newcomer.** Spend a first afternoon on the overview, then the walkthrough with the fixture open beside it, then the examples.
|
|
Read the concepts when a term in the walkthrough needs more than the glossary gives.
|
|
|
|
**Implementer.** Start with the [specification's reading paths](../spec/README.md#reading-paths), which list the chapters to read for a reader, a converter, a store and a validator.
|
|
Chapters 0, 1, 3, 4 and 5 are needed for any of them.
|
|
Next, run the section "Test your implementation against a vector" in the examples.
|
|
Check your work against the [vectors](../vectors/README.md) and the [fixtures](../fixtures/README.md).
|
|
Chapter 22 of the specification defines conformance.
|
|
|
|
**Expert.** Read the overview for scope and for what manuspec is not, then the comparison for how it differs from existing standards.
|
|
After that, read the rationale for the reason behind each rule and the questions it leaves open.
|
|
It ends with a list of limits.
|
|
Section 0.4 of the specification and [registry/formats.json](../registry/formats.json) give the status of each format: the version is 0.1.0, and each format is `candidate` or `provisional`.
|