README generator
/authoring/scribe/readme
PreviewScribe previewscribe
The README Generator assembles a README.md for a version from its guides
and its catalog, section by section. Without a scope: "Choose a project and version to assemble a
README from its guides and catalog."
Sections
The default sections are Overview, Quick Start, Authentication, Endpoints, Error Handling, Rate Limits and Changelog. + Add adds one; the arrows Move title up and Move title down reorder them, and the footer counts "X/Y generated".
Assemble fills each section by matching a guide to it by slug or title. Overview falls back to the project and version metadata, and Endpoints to the path list, when no guide matches.
Toolbar
| Button | Does |
|---|---|
| Copy Markdown | Copies the whole file ("Copied") |
| Export .md | Downloads <project-slug>-README.md |
| Assemble | Fills the sections from guides and catalog |
| Regenerate All | Disabled in this preview — "Regenerate All runs through the Scribe suggestion engine… Assemble fills sections from your guides and catalog instead." |
The README.md preview shows the rendered Markdown and the raw source. A link opens Guides to write the pages the sections draw on.
When no documentation backend answers, the generator uses worked-example guides and says so: "No documentation service answered, so these guides are worked examples rather than your content. Nothing you change here is saved."