Skip to content

docs: the Dossier format, v0.1 draft - #51

Open
francescobianco wants to merge 2 commits into
mainfrom
docs/dossier-spec
Open

francescobianco wants to merge 2 commits into
mainfrom
docs/dossier-spec

Conversation

@francescobianco

Copy link
Copy Markdown
Member

Introduces docs/dossier/SPEC.md and JSON Schemas for its three records (manifest, ledger entry, page header).

The dossier becomes the unit of work in gknowledge and an open format that other programs can implement: the folder is the truth, every compiled page has provenance by content hash, and the dossier travels (no secrets, no machine-specific paths, derived state in .dossier/). Operations are named compile / consult / audit and mapped to the LLM-wiki ingest / query / lint.

§12 lists where gknowledge 0.3 does not conform yet (SQLite-only ledger, API key inside the folder, gknowledge.json manifest, "project" naming). Those changes come in follow-up PRs; this one is documentation only.

Schemas checked with jsonschema (Draft 2020-12) against the examples in the spec, plus two invalid cases.

🤖 Generated with Claude Code

francescobianco and others added 2 commits October 27, 2026 19:39
Defines the dossier as an open, portable format: manifest, ledger,
pages with provenance, compile/consult/audit, ownership and
portability rules, conformance levels, and the gaps in gknowledge 0.3.

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

This branch has not been deployed

No deployments
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