AvailableStart
Getting started
Choose the Pinega documentation path that matches whether you need orientation, a reproducible first run, a task procedure, an explanation, or exact reference material.
Use the documentation for the job you are doing now.
The documentation is now a real corpus rather than a map of anchors. Start pages orient you, how-to guides solve concrete tasks, explanations build understanding, reference pages define exact contracts, and contributing pages describe review gates.
Documentation model
Purpose, evidence maturity, and applicability are independent.
A how-to can describe an available Web task while an explanation can document a design contract that is accepted but not yet implemented. Every nested page exposes both dimensions and its applicable programme or workspace.
- Start / Tutorial
- Orientation and guided first runs that help a reader become productive in the current workspace.
- How-to
- Goal-oriented procedures with prerequisites, commands, expected outcomes, and failure boundaries.
- Explanation
- Concepts, architecture, trade-offs, programme relationships, and the reasoning behind accepted boundaries.
- Reference
- Exact repository, environment, command, schema, and metadata contracts intended for lookup.
Current corpus
Filter documentation topics
This is a metadata-backed topic filter over real documentation pages. Site-wide full-text search remains a later gate.
13 pages
Start
Start
Orientation and reproducible first paths through the Pinega programme and workspaces.
AvailableStart
Project overview
Understand what Pinega, Pinega Labs, and Pinega Engine mean, what repository artefacts exist today, and which product claims remain future work.
AvailableTutorial
Reproduce the research workspace
Run the pinned Pinega research workspace from a clean checkout, inspect the registered documents, and build the current Typst and YDMP artefacts.
How-to
How-to
Goal-oriented procedures for concrete repository and Web tasks.
AvailableHow-to
Build and inspect the website
Build the Pinega static multi-page website from the committed lockfile, serve it locally, and inspect public and internal validation routes.
AvailableHow-to
Run the Web validation gate
Run Pinega Web token, type, unit, build, browser, accessibility, and visual-regression checks using the repository's pinned commands and Playwright environment.
Concepts
Concepts
Explanations of programme boundaries, architecture, evidence, and engineering rationale.
DecisionExplanation
Pinega programme model
Understand the relationship among Pinega, Pinega Labs, technology programmes, research infrastructure, and future product boundaries.
Design contractExplanation
Pinega Engine architecture
Understand the accepted Pinega Engine boundaries across PostgreSQL integration, mutable versions, the shared buffer pool, and one PostgreSQL WAL pipeline.
DecisionExplanation
Maturity and evidence labels
Understand how Pinega separates available artefacts, design contracts, research, decisions, hypotheses, and future implementation claims.
DecisionExplanation
Research-to-product workflow
Understand how Pinega moves work from sourced research and formalisation through executable verification, implementation, measurement, and product evidence.
Reference
Reference
Exact repository, environment, command, and metadata contracts.
AvailableReference
Repository layout
Reference the current likern/research directory boundaries for research artefacts, design assets, Web sources, generated outputs, tests, and GitHub workflows.
AvailableReference
Web build and environment
Reference the Pinega Web package scripts, pinned Node and Playwright expectations, build outputs, local server, and CI validation commands.
AvailableReference
Content metadata schema
Reference the versioned Pinega Web content registry, documentation metadata fields, generated documentation manifest, and discovery contracts used by later publishing and search gates.
Contributing
Contributing
Review, validation, and release gates for changes to the shared programme workspace.
AvailableContributing
Review and release gates
Follow the Pinega contribution rule that implementation, tests, visual artefacts, CI, evidence labels, and review all have to agree before a Web or research change is ready.
No documentation pages match this filter.
Recommended first path
Orient first; execute only after the boundary is clear.
- 01Project overview
Understand what Pinega is, what exists today, and what remains a future implementation or product claim.
- 02Reproduce the research workspace
Run the pinned toolchain and build registered research artefacts from a clean checkout.
- 03Understand Pinega Engine architecture
Read the PostgreSQL, version-store, buffer-pool, and WAL boundaries as an explanation rather than a setup guide.
- 04Review and release gates
Use the validation and evidence contracts before declaring a change or public claim ready.
Evidence maturity
The label describes evidence, not the type of page.
- Available
- A runnable or inspectable artefact exists in the repository.
- Design contract
- The architecture or contract is documented and tested as a model/specimen, not necessarily implemented as a production system.
- Research
- The topic is actively investigated and may change with evidence.
- Decision
- A project direction is accepted unless later evidence explicitly supersedes it.