Add the Zensical documentation of the Python package (docs/package, built by the docs workflow), merge the standard publish workflow with the setuptools-scm tag check, add the SPDX header rule to ruff, restructure the README, and point every repository and registry address at the Gitea organization papers. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
13 lines
845 B
Markdown
13 lines
845 B
Markdown
# Guides
|
|
|
|
Each guide takes one task from start to finish, with commands that were run against the repository's synthetic fixtures.
|
|
|
|
| Guide | For |
|
|
| --- | --- |
|
|
| [Validate a package](validate-a-package.md) | Check a package folder or a zipped package against every rule, and try a proposed correction without writing it. |
|
|
| [Load packages into SQLite](load-into-sqlite.md) | Put packages in a database you can query, or build a bundle with full-text search. |
|
|
| [Use the library](use-the-library.md) | Compute hashes and identifiers, read a package and run the gate from Python. |
|
|
| [Check and rebuild the repository](check-and-build.md) | Run the repository's checks, regenerate the vectors and fixtures, stress the oracle and build the website. |
|
|
|
|
The formats themselves are explained in the guides at <https://paperspec.scient.ing/docs/>.
|