Skip to content

Scaffold the docs/ tree with the write-docs skill #24

Description

@TitusKirch

What problem are you trying to solve?

The repo declares a docs contract in .tituskirch-skills.json — docs.preset: package, docs.render: duxt — but no docs/ tree exists. What gitignore-sync does, how it is configured, and which decisions were taken along the way live only in the README or nowhere at all.

Proposed solution

Scaffold docs/ with the write-docs skill in the TitusKirch docs format. Settled up front, so nothing is left to the implementer's judgement:

  • Preset package — the section set comes from the preset; no invented sections.
  • Rendering duxt — docs.render is set, so the duxt page contract applies: no body H1, absolute doc paths, ::page-cards in a section index, theme frontmatter fields, ::callout for the status marker.
  • Language en — from the root language key.
  • Scope — the scaffold plus the pages the preset calls for, filled from what the repo actually is today. No ADR as part of this issue.

Alternatives considered

Growing the README instead. Rejected: the config already declares both a preset and a render target, so the README would keep absorbing a docs tree without ever getting its structure.

Additional context

docs.render: duxt was added to this repo's config today. Acceptance: docs/ exists, follows the preset's sections, every page obeys the duxt contract, and no statement in it contradicts the repo.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ai: readyScoped + approved for an AI agent to pick updocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions