### Run Development Server

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Starts the local development pipeline and Zensical preview. It copies content, generates Markdown, and starts `zensical serve`. Watches for changes in content, templates, config, generator code, and rules JSON.

```bash
bun run dev
```

--------------------------------

### Example Rule Structure

Source: https://github.com/fedramp/2026/blob/main/content/rules.md

Illustrates the basic structure of a FedRAMP rule, identifying the responsible party, rule force, action, and applicability conditions. It highlights how plain language and defined terms contribute to the rule's intent.

```text
Providers MUST supply current certification data to all necessary parties

[_Providers_] [**MUST**] [_**supply current certification data**_] [to all necessary parties].

[_Responsible party_] + [**rule force**] + [_**action or condition**_] + [when, where, or how it applies]
```

--------------------------------

### Add KSI Document Entry

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Add an entry to `generated.ksiDocuments` in `config.json` to define a KSI document. This example shows a single KSI theme being generated into its own markdown file.

```json
{
  "id": "provider-20x-key-security-indicators",
  "output": "providers/20x/key-security-indicators/{KSI}.md",
  "outputMode": "themes",
  "status": "stable",
  "definitionsHref": "../../../definitions/",
  "source": {
    "collection": "KSI",
    "themes": "ALL"
  }
}
```

--------------------------------

### Run Tests

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Verifies the rules source schema, `tools/rules` sync status, generated Markdown pipeline, and full static build output. Warns about unlinked `src/*.md` pages or incorrect directory structures.

```bash
bun test
```

--------------------------------

### Markdown Frontmatter for Page Pictographs

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Example of frontmatter for manual Markdown pages to declare pictograph source and status. The `picto` block controls the inserted pictograph.

```markdown
---
picto:
  source: person
  status: stable
---

```

--------------------------------

### Run Full Static Build

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Performs the complete static build, writing output to `../html`. It removes Zensical's generated cache before invoking Zensical for a clean build.

```bash
bun run build
```

--------------------------------

### Common Project Commands

Source: https://github.com/fedramp/2026/blob/main/README.md

These commands are used to run project tooling for development, testing, checking, building, and syncing the repository.

```bash
bun run dev
```

```bash
bun test
```

```bash
bun run check
```

```bash
bun run build
```

```bash
bun run sync
```

--------------------------------

### Frontmatter for Generated Page Pictographs

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Example of frontmatter for generated or machine-sourced pages to declare pictograph source and status. This ensures consistent pictograph rendering for automated content.

```markdown
---
picto:
  source: machine
  status: stable
---

```

--------------------------------

### Set Giscus Theme on Initial Load

Source: https://github.com/fedramp/2026/blob/main/overrides/partials/comments.html

Sets the Giscus theme based on the current Material for MkDocs color palette when the page initially loads. This ensures the comment section matches the site's appearance from the start.

```javascript
var giscus = document.querySelector("script[src*=giscus]") // Set palette on initial load var palette = __md_get("__palette") if (palette && typeof palette.color === "object") { var theme = palette.color.scheme === "slate" ? "transparent_dark" : "light" // Instruct Giscus to set theme giscus.setAttribute("data-theme", theme) }
```

--------------------------------

### Project Development and Build Commands

Source: https://github.com/fedramp/2026/blob/main/AGENTS.md

These commands are used to manage the project's development cycle, including running the local generation pipeline, testing, checking code quality, building the project, and synchronizing submodules.

```bash
bun run dev
bun test
bun run check
bun run build
bun run sync
bunx tsc -p tsconfig.json --noEmit
```

--------------------------------

### Run Quality Gate

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Executes the local quality gate, including tests, TypeScript checking, and non-failing content style warnings. Style warnings are displayed last for visibility.

```bash
bun run check
```

--------------------------------

### Configure Generated Tagged Document Summaries

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Add an entry to `generated.taggedDocumentSummaries` in `config.json` to create overview pages from FRR documents. This configuration specifies the ID, title, output path, status, template, and source criteria for generating these summaries.

```json
{
  "id": "provider-20x-initial-rules-summary",
  "title": "Initial Certification",
  "output": "providers/20x/initial/index.md",
  "status": "placeholder",
  "template": "templates/tagged-document-summary.hbs",
  "source": {
    "collection": "FRR",
    "documents": "ALL",
    "types": ["20x"],
    "affects": ["Providers"],
    "tag": "initial",
    "includeAll": true,
    "allPosition": "first"
  }
}
```

--------------------------------

### Enable Pre-commit Hook

Source: https://github.com/fedramp/2026/blob/main/AGENTS.md

This command configures Git to use the project's pre-commit hook, which automatically runs 'bun run check' before each commit.

```bash
git config core.hooksPath .githooks
```

--------------------------------

### Configure Generated FRR Reference Index

Source: https://github.com/fedramp/2026/blob/main/tools/README.md

Add an entry to `generated.referenceIndexDocuments` in `config.json` to generate a table of FRR rulesets with links and status. This configuration includes an introduction, purpose, and source details for the reference index.

```json
{
  "id": "complete-ruleset-reference-index",
  "title": "Complete Ruleset Reference",
  "description": "This section contains the entire Consolidated Rules for 2026 as a standalone reference for each ruleset.",
  "purpose": "This content allows folks to see the full rules together without them broken apart by stakeholder.",
  "introduction": "This section of the Consolidated Rules for 2026 contains each complete FedRAMP Ruleset with all related content in a single rule as an overall reference. The individual stakeholder sections of this site contain only the specific rules that apply in different circumstances for different stakeholders, while the reference rulesets are entirely unabridged.",
  "output": "reference/index.md",
  "status": "stable",
  "template": "templates/reference-index.hbs",
  "source": {
    "collection": "FRR",
    "documents": "ALL"
  }
}
```