outl: Instructions file for GitHub Copilot

.github/instructions/architecture.instructions.md

outl architecture.instructions.md is an instructions file for GitHub Copilot from outlmd/outl. It costs 1,926 tokens per session, scanned A, original, MIT.

An architecture guide for outl that requires developers to search for existing shared code before adding another implementation of the same behavior.

In plain words
What is it for?
Use it when adding or changing Rust functions, import processing, backlinks, or other shared behavior. It helps you find reusable primitives and avoid parallel implementations.
Why use it?
It helps prevent duplicated logic from drifting apart and producing different results in different parts of the application. It records examples where duplicated processing caused bugs or missed review issues.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: reads .claude/ paths; mentions CLAUDE.md.

This is outlmd/outl's own configuration. It tells GitHub Copilot how to work on outl 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 outl configures →

Reuse

Borrowing it

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

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 outl architecture.instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/outlmd/outl/architecture"><img src="https://agentmods.dev/badge/instructions/outlmd/outl/architecture.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,926 This file is loaded in full into every session.
When invoked 1,926 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.01926 $0.01926
Opus 5.5 $0.00770 $0.00770
Sonnet 5.5 $0.00385 $0.00385
Haiku 4.5 $0.00193 $0.00193

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

Security

Grade A, and why

outl architecture.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/architecture.instructions.md · 86 lines

How it starts

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

Reuse-first violations — no parallel implementations

Duplication here is a real hazard: two implementations of the same logic drift apart over time, and the user is the one who hits the divergence.

Past incidents to anchor severity:

  • outl_md::index::Backlink and outl_actions::Backlink were two parallel "backlinks" pipelines that started identical and ended up disagreeing on self-references — caught by the user, not the reviewer. Collapsed into outl_actions::backlinks_for_page in 0.5.3.
  • PR #47 (Logseq import) opened with crates/outl-cli/src/cmd/import/normalize.rs reimplementing \r\n handling, id:: stripping, and long-form date rewriting — every one of which outl_actions::paste::normalize_external_syntax already owned. (That directory has since been replaced by the adapter-based crates/outl-import; the lesson carries over.) Caught in review after a Claude-assisted PR shipped without the catalog being visible. That is why the shared primitives catalog exists (see shared-primitives.instructions.md).

The rule the PR author was expected to follow:

  1. Grep before writing. rg "fn foo" / rg "struct Foo" across crates/. Look in upstream crates first, in this order: outl-core → outl-md → outl-actions. These are where shared primitives live. The catalog above is your starting point.
  2. Prefer evolving the existing API over duplicating, even if that means a small refactor (rename, generalize a parameter, move into a sibling module). One owner per concept; many callers.
  3. Refactor into the shared crate, not around it. If a TUI helper feels like it could live in outl-actions, the PR should move it there now — the mobile client will need it soon. The flatten_subtree_paths migration is the canonical pattern.
  4. Duplication is OK only when the platforms are genuinely different. outl-tui::EditBuffer and the mobile <textarea> are both "cursor + text", but one is a terminal widget Rust has to render itself and the other is a browser primitive. Same role, different runtime — not duplication. Recalculating (line, col) from cursor in both places, though, would be — extract to outl_md::view::char_to_line_col and wrap.

When you spot a duplicate, point at the existing function with file:line and ask: "can you call this instead, or extend it if it doesn't quite fit? The fix is to wrap or evolve the upstream API, never to write a parallel one. If the author argues for duplication, they have to fit it into case 4 above — same role, genuinely different runtime. Anything else is a blocker.

  • Layering violations. UI imports in outl-core. Client crates building op trees instead of calling outl-actions. Workspace mutations done outside Workspace::apply.
  • New Op variant without the full checklist. Adding a variant touches apply_op, undo_op (the inverse must be exact), the sidecar serializer, the markdown projection, the replay tests, and the per-crate docs. Check the diff against /new-op expectations and call out anything missing.
  • Trait surface that locks out a future backend. Storage must stay implementable by ChronDB later. If a new method assumes file semantics (paths, flock), question it.
  • Sidecar / op-log format changes without a migration story. Existing workspaces on disk must still load. Either the change is backward-compatible (new optional field) or there is a versioned migration path described in the PR.
  • File size growth past 600 lines. Note it, suggest a split by responsibility, point at refactor-architect agent. Past 900 lines, request a refactor before merge.
  • Premature abstraction. A new trait or generic with one impl and no second use case in sight. The Rule of Three applies — concrete first, abstract on the third caller.

Read the full file on GitHub · 86 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 · 86 lines · 1,926 tokens per session scan A f07724d52939

Subscribe to this mod's changes

outl architecture.instructions.md is an instructions file published in the GitHub repository outlmd/outl (222 stars, last pushed yesterday), licensed MIT. It adds 1,926 tokens to every session, about $0.0077 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-09-01.

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,461 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,750 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens