docs-sync

Which document to update for a given behaviour change in this repo. Use at the end of any change that alters endpoints, domain rules, schema, packages, wiring, or features — docs/ is a first-class deliverable and must ship in the same PR.

Jump to install

Repository: fjaeckel/ninerlog-api
Last source activity: July 30, 2026 at 18:44
Detected SKILL.md language: English
Stars: 3
Forks: 0

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/fjaeckel/ninerlog-api --skill docs-sync

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

api-change

The OpenAPI-first workflow for this repo. Use whenever adding, removing, or changing an HTTP endpoint, request/response field, status code, query parameter, or auth requirement — and before touching anything under internal/api/generated/ or api-spec/openapi.yaml.

2026-08-23

migrations

Database schema changes in this repo — creating golang-migrate migration pairs, naming and numbering rules, the reversible-down requirement, the test-DB init script, and repository/model follow-up. Use whenever adding a table, column, index, or constraint.

2026-08-23

testing

How to write and run tests in this repo — unit vs integration vs e2e, the build tags and env vars each tier needs, running a single test, and the pre-commit gate. Use before writing a test, running the suite, or claiming work is done.

2026-08-23

View all from this repository

name	docs-sync
description	Which document to update for a given behaviour change in this repo. Use at the end of any change that alters endpoints, domain rules, schema, packages, wiring, or features — docs/ is a first-class deliverable and must ship in the same PR.

Keeping docs accurate

Documentation in docs/ is part of the codebase. A change is not complete until its documentation matches reality. Update in the same PR:

Changed	Update
HTTP contract / endpoints	`api-spec/openapi.yaml`, `docs/API.md`, `docs/FEATURES.md`
Domain rules (flights, currency, validation, time handling)	`docs/DOMAIN.md`
Entities, schema, migrations	`docs/DATA_MODEL.md`
Packages, responsibilities, startup wiring	`docs/PACKAGES.md`, `docs/ARCHITECTURE.md`
A product feature added/removed/changed	`docs/FEATURES.md`
Auth, metrics, performance, test tooling	`docs/AUTHENTICATION.md`, `docs/METRICS.md`, `docs/PERFORMANCE.md`, `docs/RUNNING_TESTS.md`
Developer workflow / commands	`docs/DEVELOPMENT.md`, `CONTRIBUTING.md`, `README.md`

Guidelines:

Never leave documentation describing behaviour that no longer exists. If you cannot fully update a doc, say so explicitly in the PR description.
Do not hand-edit generated artefacts referenced by docs (internal/api/generated/) — regenerate them.
docs/DEVELOPER_GUIDE.md is the entry point and documentation map; keep its links valid.
Prose style in this repo: no emoji in docs, scripts, or tooling output.
.github/copilot-instructions.md is stale and contradicts the codebase in places (TypeScript/Prisma/sqlc examples). Do not treat it as a source of truth; if you touch it, correct it toward docs/.

docs-sync

Source facts

Install options

Review the source files

More from this repository

More from this repository

Keeping docs accurate

Keeping docs accurate