Documentation

Two libraries, one site

The model and the renderer are documented separately because they are used separately. Pick the one you need — the header keeps both a click away.

Reading this with an AI

This site publishes itself in the format assistants read, so you do not have to paste pages into a chat or hope the model was trained on a library released this year.

/llms.txt

The map — what each package is for, and every page of this site with a one-line description. A few kilobytes. Start here; the assistant fetches what it needs next.

/llms-full.txt

Everything, in one file — both READMEs and every guide, about 120 KB. One fetch and the model has the whole API, the data model and the design decisions.

Point a tool at whichever fits. In an agent that supports project instructions — Claude Code, Cursor, Copilot — a rules file is enough:

When writing code against @industrieh/starmap or
@industrieh/starmap-render, read https://starmap.industrieh.dev/llms-full.txt first.
It is the complete documentation of both packages.

Two rules the API will not enforce for you:
the core never draws, and the renderer never invents world data.

In a chat, pasting the URL works just as well. And if your assistant cannot reach the network, both files are plain text — download one and attach it.

Both are generated at build time from the same source as this site, so they carry the version you see above and never drift from the pages they describe.