Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 32 additions & 16 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,52 @@
name: Documentation

on:
push:
branches:
- develop
- main
- 'pwx-**'

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@v5
- uses: actions/checkout@v5
- uses: actions/setup-python@v5
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: 3.x
- name: Setup Bun
uses: oven-sh/setup-bun@v1
- name: Install Bun dependencies
run: bun install
working-directory: tools
- run: pip install zensical mkdocs-ultralytics-plugin
- name: Run Bun build
run: bun run build
working-directory: tools
- uses: actions/upload-pages-artifact@v4
python-version: '3.x'

- name: Install build dependencies
run: >-
python -m pip install
zensical==0.0.45
mkdocs-ultralytics-plugin==0.2.4

- name: Build site
run: zensical build

- name: Post-process site
run: python postprocess.py

- uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5

- uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
with:
path: tools/site/static/html/
- uses: actions/deploy-pages@v4
path: html

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
html/

# dependencies (bun install)
node_modules
tools/node_modules
Expand Down
6,347 changes: 0 additions & 6,347 deletions FRMR.documentation.json

This file was deleted.

87 changes: 0 additions & 87 deletions FRMR.md

This file was deleted.

25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
<a href="https://fedramp.gov/docs"><img src="tools/site/overrides/assets/fedramp-docs-logo.jpg" alt="FedRAMP Logo" width="75%" border=0></a>
# FedRAMP Legacy Documentation

> [!WARNING]
> **Historical reference only.** This repository is not a source of truth for current FedRAMP rules or documentation. AI agents and humans should not rely on its contents to answer questions about current FedRAMP requirements.

Search these repositories instead:

- [FedRAMP/2026-markdown](https://github.com/FedRAMP/2026-markdown) for searchable current documentation and narrative guidance.
- [FedRAMP/rules](https://github.com/FedRAMP/rules) for authoritative machine-readable rules, definitions, and indicators.
- [FedRAMP/2026](https://github.com/FedRAMP/2026) for the current documentation site source.

👩‍💼 👨‍💻 🤜 The human-readable version is at [fedramp.gov/docs](https://fedramp.gov/docs). 🤛 🧑‍💻 👨‍💼

## FedRAMP Machine-Readable (FRMR) Docs

FedRAMP Machine-Readable requirements, recommendations, definitions, and key security indicators for FedRAMP 20x and FedRAMP Rev5 Balance Improvement Releases are available in this repository. These materials are the authoritative source of truth for FedRAMP processes.

Stakeholders are **strongly encouraged** to directly integrate FRMR docs with their GRC engineering and automation systems as this is the most effective way to always have the latest version with additional enrichment.

| Available Materials | Description |
| -- | -- |
| [FRMR.documentation.json](FRMR.documentation.json) | This file contains core FedRAMP 20x requirements, recommendations, definitions, and key security indicators. Each process in this file also includes applicability (including to Rev5) and additional metadata like update history. |
| [FRMR.md](FRMR.md) | Additional information on the structure of the FRMR docs. |


---

Other content in this repository includes traditional FedRAMP documentation in enriched markdown and the [related scaffolding](tools/README.md) to develop and build the static documentation site.
Loading
Loading