docouture-docs-internals
Skill246 starsChanged 46 days agoApache-2.0View on GitHub
How a docouture Antora documentation site is put together: the playbook, the docs/antora.yml component descriptor, the four names that must agree, the ROOT+main default layout, promoting Guides/Reference to their own modules, the per-artifact-module strategy for a monorepo, and the home-page vs. content-page patterns. USE WHEN adding a page or module, renaming the site/component, deciding whether a section or artifact earns its own module, building a landing/home page, or diagnosing a site that builds with zero pages or fails with 'start page not found'. EXAMPLES: 'add a new module', 'rename this docs site', 'build a marketing home page', 'the site builds but has no pages', 'start page not found', 'should this artifact get its own module'.
Files
Site structure
This site was scaffolded by docouture new (@inditextech/docouture-cli). This skill covers the
pieces that make it hang together — where each name is set, how a page becomes reachable,
and the two page patterns (home vs. content) worth copying rather than reinventing.
reference/naming.md— the four names that must agree, and how to fix them when they don't (docouture doctorchecks this automatically).reference/page-patterns.md— the home-page block structure, the recurring content-page shapes, the always-presentROOT+mainlayout, and how a site grows more modules (promoted sections, or one per artifact in a monorepo).reference/antora-extensions.md— what@inditextech/docouture-antora-extensions(a different kind of extension from the authoring blocks indocouture-writing-docs-pages) provides: the module switcher, site footer, search index andllms.txtgeneration.
For AsciiDoc authoring itself — xrefs, admonitions, code blocks, this site's custom
blocks — see the docouture-writing-docs-pages skill. For which modules/pages a site
should have in the first place, see docouture-getting-started (new site) or
docouture-documenting-changes (an existing site gaining a new module/artifact).
The moving pieces
docs/
antora-playbook.yml site title, content source, UI bundle, asciidoc/antora extensions
antora-playbook.local.yml same shape, but content.sources[] is just `branches: HEAD` —
what `docouture dev` and PR verification build against, since a
PR/feature-branch checkout doesn't have `main` or a release tag
package.json name, devDependencies (docouture-cli, ui-bundle, the two extension
packages), the `build`/`dev` scripts
src/
antora.yml component descriptor: name, title, version, nav
modules/<module>/nav.adoc navigation tree, one per moduleThe whole starter template — package.json, both playbooks, the nested src/ — was
copied under this repository's own docs/, so antora-playbook.yml lives at
<repo-root>/docs/antora-playbook.yml and the component descriptor ends up one level
further down, at docs/src/antora.yml. That's why antora-playbook.yml's
content.sources[0] reads url: .. (this repo's root, one level up from docs/) and
start_path: docs/src.
docs/build/ (git-ignored) is generated output, not part of this tree — never edit
or delete it directly. If docouture dev is running, it owns that directory and
rebuilds it live on every save; a second, ad-hoc build into the same path (or clearing
it by hand) pulls the site out from under that running server.
Versioning
docs/antora.yml's version/prerelease fields are identical on main regardless of
which versioning mode this site uses (version: prerelease, prerelease: true) — what
differs is only which git refs antora-playbook.yml's content.sources[0] aggregates
from (tags: ['docs/stable'] vs. tags: ['docs/v*']). If this site was scaffolded with
--mode versioned, see the docouture-docs-versioning skill for cutting a release; a
standalone-mode site (the default) has no separate skill for this — docouture doctor
and the docouture-release.yml workflow are all that's needed.
In this repository56 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- cavemanSkill
- design-an-interfaceSkill
- diagnoseSkill
- docouture-authoring-guidesSkill
- docouture-docs-versioningSkill
- docouture-documenting-changesSkill
- docouture-getting-startedSkill
- docouture-writing-docs-pagesSkill
- edit-articleSkill
- git-guardrails-claude-codeSkill
- grill-meSkill
- grill-with-docsSkill
- handoffSkill
- improve-codebase-architectureSkill
- migrate-to-shoehornSkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-exploreSkill
- openspec-proposeSkill
- openspec-sync-specsSkill
- openspec-update-changeSkill
- openspec-verify-changeSkill
- prototypeSkill
- qaSkill
- request-refactor-planSkill
- reviewSkill
- scaffold-exercisesSkill
- setup-matt-pocock-skillsSkill
- setup-pre-commitSkill
- tddSkill
- teachSkill
- to-issuesSkill
- to-prdSkill
- triageSkill
- ubiquitous-languageSkill
- write-a-skillSkill
- writing-beatsSkill
- writing-fragmentsSkill
- writing-shapeSkill
- zoom-outSkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-exploreSkill
- openspec-proposeSkill
- openspec-sync-specsSkill
- openspec-update-changeSkill
- openspec-verify-changeSkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-exploreSkill
- openspec-proposeSkill
- openspec-sync-specsSkill
- openspec-update-changeSkill
- openspec-verify-changeSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

