hve-core docusaurus-edits.instructions.md

Documentation-writing instructions for Docusaurus, a tool that builds documentation websites from Markdown and related files.

In plain words
What is it for?
They define required frontmatter such as title, description, author, date, topic, and keywords, plus optional sidebar and reading-time fields.
Why use it?
They help documentation pages pass the project's required checks and remain consistent in search metadata and navigation.

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/microsoft/hve-core/docusaurus-edits
Clone the repo
git clone --depth 1 https://github.com/microsoft/hve-core

Made for: GitHub Copilot.

Per session 1,695 This file is loaded in full into every session.
When invoked 1,695 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.01695 $0.01695
Opus 5 $0.00847 $0.00847
Sonnet 5 $0.00339 $0.00339
Haiku 4.5 $0.00169 $0.00169

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

Security

Grade A, and why

hve-core docusaurus-edits.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/docusaurus-edits.instructions.md · 223 lines

How it starts

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

Docusaurus Content Instructions

These instructions apply automatically when editing any file under docs/. Follow them to maintain consistency across the documentation site.

Frontmatter

Every documentation page requires these frontmatter fields. npm run lint:frontmatter fails when any of them is missing or empty, and the check runs in PR validation:

  • title: Page title displayed in the browser tab and sidebar
  • description: One-sentence summary for SEO and social sharing
  • author: Author or team responsible for the content
  • ms.date: Last review or update date in YYYY-MM-DD format
  • ms.topic: One of overview, concept, tutorial, reference, how-to, troubleshooting, architecture
  • keywords: Non-empty list of content categorization terms

Optional fields:

  • sidebar_position: Integer controlling page order within its category (1, 2, 3...)
  • sidebar_label: Override the sidebar display text when it should differ from title
  • tags: Array of tags for content categorization
  • estimated_reading_time: Positive integer in minutes
---
title: The RPI Workflow
description: How the Research-Plan-Implement-Review loop structures AI-assisted development
author: Microsoft
ms.date: 2026-08-04
ms.topic: concept
keywords:
  - rpi
  - research
  - plan
  - implement
  - review
sidebar_position: 2
sidebar_label: RPI Workflow
tags: [build-the-work, rpi, workflow]
---

Update ms.date to the current date whenever you review or change a page.

Two subtrees follow different rules:

  • Architecture Decision Records under docs/planning/adrs/ are governed by adr-frontmatter.schema.json. They use tags for categorization and must not declare keywords.
  • Pages under docs/reference/ are generated by npm run docs:generate, which emits the required fields automatically. Do not hand-edit their frontmatter.

Admonitions

Both Docusaurus admonitions (:::note, :::tip, :::warning) and GitHub-style alerts (> [!NOTE], > [!TIP], > [!WARNING]) are supported. GitHub-style alerts render correctly in Docusaurus via remark-github-blockquote-alert and on GitHub natively. Prefer GitHub-style alerts for content that must render on both platforms.

Read the full file on GitHub · 223 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 · 223 lines · 1,695 tokens per session scan A 5d005b162297

Subscribe to this mod's changes

hve-core docusaurus-edits.instructions.md is an instructions file published in the GitHub repository microsoft/hve-core (1,405 stars, last pushed 2d ago), licensed MIT. It adds 1,695 tokens to every session, about $0.0085 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

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

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 · 6,785 tokens

next.js 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,296 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 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,345 tokens