Agent docs
What a coding agent needs to build a plugin on Topic Map.
Every page here is Markdown at its own address. The same files ship inside the API package, matched to the version you install.
Give your agent this
Paste these lines into your plugin's AGENTS.md. Agents read that file every session; without the pointer, most never look inside node_modules.
## Topic Map
Before writing code that calls Topic Map, read
node_modules/@insurgently/topic-map-api/AGENTS.md.
It matches the installed version; prefer it to what you remember.The files
Short pages, each about one thing. An agent reads AGENTS.md first and follows its links.
AGENTS.mdNine rules for a plugin that calls Topic Map, and where everything else is.agents/AGENTS.mdREADME.mdExamples for search, the map, map layers and the catalog calls.agents/README.md- ChangelogWhat each API version added, and what broke.agents/CHANGELOG.md
- GlossaryThe terms, with meanings, ids, icons and code names.agents/ia.json
llms.txtThe index: one line per file.llms-full.txtis all of them in one file.agents/llms.txt
Where they live
One set of files, written in the repo, copied to two places at release. Read the package copy when you can: it is the version you have.
- In the API package
node_modules/@insurgently/topic-map-api/:AGENTS.md,README.md,CHANGELOG.mdandia.json. Matched to the installed version, and there offline.- On this site
- The latest release. Every page has a
.mdtwin at the same address, which an agent also gets by asking for Markdown, and a Copy as Markdown button.llms.txtandllms-full.txtsit beside them. - In the repo
- Where the files are written. The
AGENTS.mdat the repo's root is for agents working on Topic Map itself;api/AGENTS.mdis the one for callers.
How they stay current
- Each page here starts with the date it was built and its source in the repo.
- The pages are the package's own files, copied at release, so the site and the package can't disagree.