Skip to content

tools/archdiagram

import "github.com/nuqs-org/nuqs/tools/archdiagram"

Command archdiagram writes docs/architecture.md, a diagram and a map of the repo built straight from the code.

It reads every Go file's package doc comment and imports, and lists every file in the repo. Nothing is typed by hand, so the page can't drift from the code. CI runs it on every push and commits the result if it changed.

Run it from the repo root:

go run ./tools/archdiagram          # write docs/architecture.md
go run ./tools/archdiagram -check   # only check it's up to date

Note

This is a program, not a library, so it has no API to list.