How-to guides — Study App

Overview

Use this index when you want steps for a task, not only policy text. For decisions, see ADRs. For detailed specs, see RFCs. For writing rules and audits, see Documentation style guide and audit standard.

If you are new here, follow this order. It takes you from setup to a PR that is ready for review.

Run full onboarding guide: Onboarding from zero to endpoint and docs.
Use the concrete endpoint implementation example: Add POST /api/v1/contract (beginner walkthrough).
Update internal service docs structure and navigation: Internal service docs layout and how to add pages.
Validate writing style and structure against: Documentation style guide and audit standard.

Use this list when you change behavior and need to update the docs to match.

Define document type and target location (internal API page, how-to, runbook, ADR, RFC).
Create or update page content using the required section structure from document-type matrix.
For internal service pages, keep navigation and shell consistent with internal docs layout guide.
Update links on hub pages (this index, internal indexes, ADR/RFC/runbook lists) when a new page is part of the official flow.
Run documentation build and normalization:
```
make docs-fix
```
Run checks and drift validation before push:
```
make docs-check
```

Guide	When to use it
Onboarding: from zero to endpoint and docs	First-time path from setup to quality gates.
Internal service docs layout and how to add pages	Add or change pages under `docs/internal/`, sidebar, and layout.
Beginner walkthrough: add `POST /api/v1/contract`	Example endpoint wired through all service layers.

More context and policies around the tasks above.

Date	Change	Author
2026-04-21	Added Page history section (repository baseline).	Ivan Boyarkin