Inkan
↑↓ move↵ open
GitHub

印鑑 · ADR & RFC sites

Inkan

Decisions deserve a home as good as your API docs. Inkan turns a folder of Markdown architecture decision records and RFCs into a fast, searchable site: a folder per team, a printed cover per record, one place to find out why things are the way they are.

Quick startWhat is InkanGitHub

npm create @tilaven/inkan@latest my-decisions
A fan of five record cards with risograph-style covers for the SRE, Payments, Platform, DBRE and Checkout teams.A fan of five record cards with risograph-style covers for the SRE, Payments, Platform, DBRE and Checkout teams.

Features

Try it, right now

two commands, one minute
Terminal window
npm create @tilaven/inkan@latest my-decisions
cd my-decisions && npm install && npm run dev

Open http://localhost:4321 and you are looking at your own decision archive, with a sample project to edit. Already have a repository with ADRs? Run npm install -D @tilaven/inkan and npx inkan init there, or bring them over with inkan import from log4brains, MADR or adr-tools.

How to read these docs#

Every feature of Inkan is described by an ADR in one of the projects below: why it exists, what was decided and how to use it. Ideas that are not built yet are RFCs and wait on the backlog. This site is built with Inkan from the docs/ folder of the repository, so what you are reading is also what your own records will look like.

Teams

one folder and one _project.yml each

Latest

newest first