0 Fork 0

Files

T

feat: rename to paperspec and add the website

- Rename manuspec to paperspec everywhere outside pixi.toml: prose, the
  tools, provenance tool names and the fixture key derivations, so every
  fixture and vector is rebuilt.
- Move the namespace addresses under the site, mirroring the repository:
  schema $id https://paperspec.scient.ing/schemas/<file>, the JSON-LD
  context https://paperspec.scient.ing/context/scienting-1.jsonld, and
  term IRIs https://paperspec.scient.ing/vocab#<term>. Format
  identifiers (scienting-*) and URNs (urn:scienting:) are unchanged.
- tools/site.py (standard library only) builds _site/: every file of the
  repository at its own path, each Markdown file rendered as a page with
  sidebar navigation, heading anchors matching the forge's, folder
  listings, a vocabulary page for the context's IRIs, a heading search
  and a 404 page; light and dark themes.
- check.py builds the site and checks that every Markdown file has a
  page, every internal link and fragment resolves, no Markdown is left
  unrendered, and every $id, the context address and the vocabulary IRIs
  are files of the site.
- deploy/: a Caddyfile with the media types and CORS the data needs, and
  a guide; .gitea/workflows/site.yml builds on main and publishes with
  rsync when the SITE_* secrets are set.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-14 21:27:21 -04:00

4.1 KiB

Raw Blame History

Contributing

This page is for anyone who wants to fix the specification, change a format or add an example. Propose a change as a pull request on the repository at https://git.scient.ing/infra/paperspec.

What a change needs

A change starts in the chapter of the specification that defines the rule, because the chapters are normative. The schemas, SQL, registries, vectors and fixtures then follow the chapter (spec/00 §0.5).

Change the chapter. Say what is new in the chapter's own terms, and link the sections it touches.
Change the schemas, SQL and registries that the rule shapes. A new refusal gets a rule ID in registry/rules.json.
Compute, never type, the expected values. Change the oracle in tools/oracle/ to apply the rule, and add the case that shows it to tools/build.py: a vector, a fixture or a broken package in fixtures/invalid/. Then run pixi run build, which rewrites fixtures/ and vectors/.
Run the checks. pixi run check must end with All checks pass. Without pixi, run python3 tools/check.py, with Python 3.14 and two packages, jsonschema and cryptography installed.
Record the change in CHANGELOG.md.

Versions

A change that makes a valid file invalid, or that changes a computed value, is a breaking change and needs a new major version of the format, with a migration. Adding an optional property, a node kind, a run kind or an enumeration value is a minor change (spec/00 §0.3). A rebuild that changes any file under vectors/ or any hash in fixtures/ is a computed value changing, so say in the pull request why it must.

New node kinds and run kinds

Propose a kind with the vector or fixture that shows it. A node kind needs its row in chapter 3, the node schema, and its entry in the CHILDREN table of tools/oracle/model.py. A run kind needs its row in section 3.5 and the node schema, and its text in the plain projection (3.6) and in the strict and lossy projections (5.3, 5.5).

Releasing

A release is a tag on main whose version is the top heading of CHANGELOG.md. Before tagging:

pixi run check passes on Linux and macOS, which the workflow in .gitea/workflows/ runs on every push. The check also confirms that every count the prose states (formats, schemas, vectors, broken packages) matches the repository, and that pixi.toml, the registries and tools/build.py state the same version.
python3 tools/stress.py passes with its default seed, and with one or two others.
The website is published from the release (deploy/), and the JSON-LD context at https://paperspec.scient.ing/context/scienting-1.jsonld and a schema at its $id both answer with their media types. Layers claim to be W3C Web Annotations, and a JSON-LD processor that cannot fetch the context cannot read them.
The decisions that freeze on release are made: enumeration values and format identifiers never change meaning afterwards (spec/22 §22.5), so a name worth changing is changed now.
The CHANGELOG entry describes the release in the terms of the chapters it touches.

Writing

The checker enforces two rules on every Markdown file: one sentence per line, and US spelling. pixi run lint runs markdownlint with the repository's settings. Define each term where it first appears, because the guides and READMEs are written for newcomers as well as implementers.

All fixture text is synthetic, written for the fixtures. The keys in fixtures/keys/ are public test keys and must never sign anything else.

Licenses

Each path keeps the license that LICENSE.md gives it: prose CC-BY-4.0, the normative data CC0-1.0, and tools/ Apache-2.0.

4.1 KiB Raw Blame History