Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.01 KB

README.md

File metadata and controls

54 lines (40 loc) · 3.01 KB

RULER documentation

Use this index to learn the project, run a first example, and find exact operational or reference material. The project README explains purpose and scope; agent instructions govern repository work.

Start here

First use → system architecture → trust model → CLI and HTTP API.

Maintainers: contributing and release checklist.

Then consult the detailed project guide for the preserved capabilities, examples, workflow descriptions, and integration notes.

Documentation areas

Area What you will find
Getting started Install the environment and complete a first example.
Concepts Understand the project model, terminology, and evidence boundaries.
Guides Carry out tasks and interpret their outputs.
Architecture Understand components, data flow, contracts, and extension points.
Reference Look up commands, skills, workflows, and documentation sources.
Development Change the project and run the relevant checks.
Operations Configure, run, observe, and release maintained workflows.
Governance Check licensing, provenance, review, and publication requirements.
Archive Find historical material and distinguish plans from current behavior.

Project-specific collections

The documentation map lists retained collections and source pages, including material outside the common reading areas.

Documentation conventions

Authored guides explain current behavior; registries and source contracts define exact runtime details. Generated catalogs and reports are derived views. Plans, proposals, archived pages, and historical snapshots do not by themselves establish implemented capability or scientific validity. Check each page's stated scope and status.

Existing specialist paths remain stable to preserve links, provenance, and detail. New onboarding and navigation use the nine areas above. See documentation maintenance before reorganizing content.