docs-ssot: Instructions file for GitHub Copilot

.github/instructions/docs.instructions.md

docs-ssot docs.instructions.md is an instructions file for GitHub Copilot from hiromaily/docs-ssot. It costs 1,292 tokens per session, scanned A, original, MIT.

Documentation instructions for a project that generates files from source documents and templates. They define a single source of truth, meaning generated files such as README.md, AGENTS.md, and CLAUDE.md should be produced by the documentation build process.

In plain words
What is it for?
Use them when updating project documentation, choosing the correct file to edit, and rebuilding the generated documentation with the project’s documented command.
Why use it?
They prevent changes from being lost or overwritten by telling contributors where edits belong. They also clarify which files are source files and which are generated outputs.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md; mentions AGENTS.md; mentions Codex.

This is hiromaily/docs-ssot's own configuration. It tells GitHub Copilot how to work on docs-ssot itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything docs-ssot configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is <!-- @include: ../sections/ai/rules/general.md level=-1 -->.

Reuse

Borrowing it

Nothing to install: this file belongs to hiromaily/docs-ssot. 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/hiromaily/docs-ssot/main/.github/instructions/docs.instructions.md
Clone the repo
git clone --depth 1 https://github.com/hiromaily/docs-ssot

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.

agentmods badge for docs-ssot docs.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/hiromaily/docs-ssot/docs/github.svg)](https://agentmods.dev/instructions/hiromaily/docs-ssot/docs)
Your own site
<a href="https://agentmods.dev/instructions/hiromaily/docs-ssot/docs"><img src="https://agentmods.dev/badge/instructions/hiromaily/docs-ssot/docs/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.

agentmods 80×15 button for docs-ssot docs.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/hiromaily/docs-ssot/docs"><img src="https://agentmods.dev/badge/instructions/hiromaily/docs-ssot/docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,292 This file is loaded in full into every session.
When invoked 1,292 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.01292 $0.01292
Opus 5.5 $0.00517 $0.00517
Sonnet 5.5 $0.00258 $0.00258
Haiku 4.5 $0.00129 $0.00129

Measured 1mo ago against content hash bae2913ac275, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs-ssot docs.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 1mo 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.instructions.md · 172 lines

How it starts

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

Documentation Rules for docs-ssot

SSOT Principle: Only Edit Source Files

This project generates documentation from source files. The pipeline is:

template/docs/**/*.md  +  template/*.tpl.md  +  docsgen.yaml
                          ↓
              docs-ssot build (make docs)
                          ↓
          README.md / AGENTS.md / CLAUDE.md

Generated Files — Never Edit Directly

The following are build artifacts and must NOT be modified:

  • README.md
  • AGENTS.md
  • CLAUDE.md

If you need to change content in these files, find the source file under docs/ that contains that section and edit it there, then run make docs.


Source Files — Where to Make Changes

All documentation content lives under docs/. Edit files here:

Directory Purpose
docs/01_project/ Project overview, vision, background
docs/02_product/ Product concept and feature descriptions
docs/03_architecture/ System architecture, pipeline, diagrams
docs/04_development/ Setup, testing, linting guides
docs/05_ai/ AI tool-specific instructions (Claude, Cursor, Codex, etc.)
docs/06_reference/ Commands reference, directory structure

Templates — Structure Only

Template files in template/ define document structure using include directives. Modify templates only to change document structure (add/remove/reorder sections), not content.

template/README.tpl.md
template/AGENTS.tpl.md
template/CLAUDE.tpl.md

Adding New Content

  1. Create or edit the appropriate file under docs/.
  2. If it's a new file, add an include directive in the relevant template/*.tpl.md:
    <!-- @include: docs/XX_category/new-file.md -->
    
  3. Run make docs to regenerate output files.
  4. Commit both the source file and regenerated outputs together.

Include Directive Format

Include directives follow the VitePress style:

<!-- @include: path/to/file.md -->

Read the full file on GitHub · 172 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.

  1. 1mo ago First seen · 172 lines · 1,292 tokens per session scan A bae2913ac275

Subscribe to this mod's changes

docs-ssot docs.instructions.md is an instructions file published in the GitHub repository hiromaily/docs-ssot (2 stars, last pushed 6mo ago), licensed MIT. It adds 1,292 tokens to every session, about $0.0052 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.

Related

Other instructions, from other repositories

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

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,581 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens