Documentation Index
Fetch the complete documentation index at: https://docs.rffl.dev/llms.txt
Use this file to discover all available pages before exploring further.
Source Conversion
Raw source files stay in the repository. Public pages are curated .mdx summaries that point back to source paths.
Conversion Rules
| Source type | Public treatment |
|---|
| Markdown source docs | summarize into .mdx, keep raw path in source |
| CSV data | summarize fields and source authority, do not publish raw tables wholesale |
| Python/YAML/JSON | explain what they control, do not expose implementation as member-facing docs |
| Generated recaps | summarize status and source boundaries |
Publication Classes
| Class | Meaning |
|---|
| Public + sidebar | Primary hub or high-traffic page listed in docs.json |
| Public + hidden | Detail page that is linked from a hub but intentionally omitted from the sidebar |
| Source-only | Raw .md, .csv, .py, .json, or .yaml source that stays unpublished |
Hidden public pages must include a Related section back to the parent hub. Source-only files should be cited from public pages, not linked as sidebar routes.
Required Page Contract
Every public page should include title, description, owner, status, source, a plain-English summary, source-backed tables, and explicit boundaries for incomplete data.
| Page | Use it for |
|---|
| Knowledge Base Maintenance | Maintenance hub and runbook |
| Source Conversion | Convert raw sources into public pages |
| Publication Checklist | Pre-publish checks |
| Verification Checklist | Local verification expectations |