What is Axon docs-writer.instructions.md?

A set of documentation instructions for the Axon repository. It explains which files cover the user guide, command reference, model advice, API integration, and developer reference, and when each should be updated.

Use it after adding loaders, configuration options, API endpoints, or model recommendations to update README.md, QUICKREF.md, MODEL_GUIDE.md, config.yaml, tools, and source-code documentation.

It keeps documentation aligned with code changes instead of leaving new loaders, settings, endpoints, or model recommendations undocumented. It also sets a consistent style for docstrings, which are documentation written next to code.

How jyunming/Axon configures GitHub Copilot

Reuse

Borrowing it

Nothing to install: this file belongs to jyunming/Axon. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/jyunming/Axon/main/.github/instructions/docs-writer.instructions.md

Clone the repo

git clone --depth 1 https://github.com/jyunming/Axon

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/jyunming/axon/docs-writer/github.svg)](https://agentmods.dev/instructions/jyunming/axon/docs-writer)

Your own site

<a href="https://agentmods.dev/instructions/jyunming/axon/docs-writer"><img src="https://agentmods.dev/badge/instructions/jyunming/axon/docs-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/jyunming/axon/docs-writer"><img src="https://agentmods.dev/badge/instructions/jyunming/axon/docs-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 624 This file is loaded in full into every session.

When invoked 624 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00624	$0.00624
Opus 5.5	$0.00250	$0.00250
Sonnet 5.5	$0.00125	$0.00125
Haiku 4.5	$0.00062	$0.00062

Measured 28d ago against content hash 358f6efa4ba7, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

Axon docs-writer.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 28d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/docs-writer.instructions.md · 68 lines

How it starts

The opening of the file, as written. The whole thing — 68 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Role: Documentation Writer

You are the documentation writer for the Axon repository. You keep docs accurate, concise, and synchronized with the code.

Documents You Own

File	Purpose
`README.md`	User-facing quickstart and feature overview (also the PyPI page — absolute links only)
`docs/GETTING_STARTED.md`	The first run: install, ingest, first answer, other ways in
`docs/REFERENCE.md`	Every setting, CLI flag, REPL command, REST route, MCP tool and VS Code feature, and how each feature works
`docs/SHARING.md`	Plaintext and sealed sharing
`docs/TROUBLESHOOTING.md`	Error messages and fixes
`CONTRIBUTING.md`	Development, tests, evaluation, releases
Docstrings in `src/axon/`	Developer reference

When to Update What

After adding a new loader

Update README.md features section if the format is user-facing (e.g., PDF, DOCX).

After adding a new config option

Declare it as an AxonConfig field (never getattr(cfg, "name", default)).
Add it to the matching table in docs/REFERENCE.md section 3 (Configuration), with its default.
Add a commented example line to config.yaml.template if users are likely to set it.

After adding a new API endpoint

Add it to the route tables in docs/REFERENCE.md section 8 (REST API), with its body if non-trivial.
Register the capability in src/axon/surface_contract.py; only add an MCP / VS Code tool if agents genuinely need it.

After a model recommendation changes

Update docs/REFERENCE.md section 5 (LLM providers and embeddings).

Docstring Style

Use Google-style docstrings:

def search(self, query: str, top_k: int = 10) -> List[Dict[str, Any]]:
    """Search the BM25 index for relevant documents.

    Args:
        query: The search query string.
        top_k: Maximum number of results to return.

    Returns:
        List of document dicts with keys: id, text, score, metadata.
        Returns empty list if index is not initialized.
    """

Read the full file on GitHub · 68 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

28d ago Changed · +3 lines · +132 tokens per session 358f6efa4ba7
1mo ago First seen · 65 lines · 492 tokens per session scan A 109fb79d31d7

Subscribe to this mod's changes

Axon docs-writer.instructions.md is an instructions file published in the GitHub repository jyunming/Axon (4 stars, last pushed 28d ago), licensed MIT. It adds 624 tokens to every session, about $0.0025 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Claude Code Writing and docs embeddings fastapi graphrag hybrid-search knowledge-base

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

Axon: Instructions file for GitHub Copilot