apex-accelerator markdown-docs.instructions.md

Writing guidance for Markdown documentation in an Astro Starlight documentation site and the repository's docs folder. It covers visual style, headings, templates, links, code blocks, and audience-specific rules.

In plain words
What is it for?
Use it when creating or editing human-written Markdown documentation, especially workflow guides and concept pages that follow established templates.
Why use it?
Documentation becomes harder to navigate when pages use inconsistent structure or formatting. These rules keep related pages predictable and compatible with internal links.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/jonathan-vella/apex-accelerator/markdown-docs
Clone the repo
git clone --depth 1 https://github.com/jonathan-vella/apex-accelerator

Made for: GitHub Copilot.

Per session 622 This file is loaded in full into every session.
When invoked 622 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00622 $0.00622
Opus 5 $0.00311 $0.00311
Sonnet 5 $0.00124 $0.00124
Haiku 4.5 $0.00062 $0.00062

Measured 2d ago against content hash 1f57726899d8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

apex-accelerator markdown-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 2d 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/markdown-docs.instructions.md · 66 lines

How it starts

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

Markdown — Documentation Site Standards

Audience-specific style and template rules for human-authored documentation in the Astro Starlight site (site/src/content/docs/**) and the in-repo docs/** folder. Cross-cutting rules (line length, ATX headings, code fences, link syntax, patterns-to-avoid) live in markdown.instructions.md and apply here too.

Template-First Approach (site content)

For documentation pages that mirror agent-output structure (for example, the workflow walkthroughs and the concepts/how-it-works/ set), preserve the H2 heading order from the canonical agent-output templates so that internal links from agent-output pages resolve.

  • Preserve H2 heading order — invariant sections come first
  • No embedded skeletons — link to templates instead of copying them
  • Optional sections after the last required H2
  • The full template registry is enforced by tools/scripts/validate-artifacts.mjs (applies to agent-output/**, not site content — included here for reference)

Visual Styling

See azure-artifacts/SKILL.md for the canonical styling reference (badges, emoji, callouts, status icons, collapsible sections). Reproduce these conventions consistently on the documentation site so internal cross-links between site content and agent-output artifacts feel unified.

Common reusable elements:

Element Source
Badge row ![Step] / ![Status] / ![Agent] shields
Collapsible TOC <details open> block with section links
Traffic-light status ✅ / ⚠️ / ❌ (all three required when used as a column)
Cross-navigation Header table with ⬅️ Previous / 📑 Index / Next ➡️

MDX-Specific Rules

For .mdx files under site/src/content/docs/:

  • Component imports go at the top of the file, after the frontmatter
  • Use Astro Starlight components (<Aside>, <Tabs>, <TabItem>) over raw HTML where equivalents exist
  • Keep frontmatter title and the first heading aligned; Starlight renders the title automatically so do not duplicate it with an H1

Read the full file on GitHub · 66 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. 2d ago First seen · 66 lines · 622 tokens per session scan A 1f57726899d8

Subscribe to this mod's changes

apex-accelerator markdown-docs.instructions.md is an instructions file published in the GitHub repository jonathan-vella/apex-accelerator (50 stars, last pushed 6d ago), licensed MIT. It adds 622 tokens to every session, about $0.0031 per session on Opus 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-30.

Related

Other instructions, from other repositories

claude-code-settings copilot-instructions.md

Instructions for feiskyer/claude-code-settings, covering claude.md, environment setup, required dependencies, configuration and skills.

feiskyer/claude-code-settings · 649 tokens

squad copilot-instructions.md

Copilot instructions for bradygaster/squad, covering copilot coding agent — squad instructions, ⚠️ identity lock — read this first, 🚦 route before you act — generic copilot sessions, adversarial input handling and team context.

bradygaster/squad · 1,349 tokens

vscode-unify-chat-provider AGENTS.md

Instructions for smallmain/vscode-unify-chat-provider, a project described as: Integrate multiple LLM API providers into VS Code's GitHub Copilot Chat using the Language Model API. One-click use of your Claude Code, Gemini CLI, Antigravity, Github Copilot, OpenAI Codex (ChatGPT Plus/Pro), xAI Grok (SuperGrok / X…

smallmain/vscode-unify-chat-provider · 271 tokens

agent-rules testing.instructions.md

Instructions for lirantal/agent-rules, covering testing guidelines for node.js applications, general testing principles, guiding principles, descriptive test naming (three-part structure) and structure tests by the aaa pattern.

lirantal/agent-rules · 6,713 tokens

agent-rules child-process.instructions.md

Instructions for lirantal/agent-rules, covering system processes secure coding guidelines, your mission and spawning system processes.

lirantal/agent-rules · 196 tokens

ab100 AGENTS.md

Instructions for timothywarner-org/ab100, covering agents.md, repository purpose, source of truth, course structure and poc app.

timothywarner-org/ab100 · 1,542 tokens