Skip to content

Reconcile the docs/ tree to the duxt page contract #22

Description

@TitusKirch

What problem are you trying to solve?

.tituskirch-skills.json now declares docs.render: duxt, but the existing docs/ tree was written under the portable contract. Today 5 pages open with a body H1, 3 link with relative .md paths, and the tree contains no ::page-cards and no ::callout. The config and the tree contradict each other, and the tree is the half that is wrong.

Proposed solution

Run the write-docs reconcile sweep over docs/ so the tree matches the contract it declares. Settled up front:

  • Preset package stays — no sections added, renamed or removed. This is not a restructuring.
  • The five duxt page rules apply — no body H1, absolute doc paths, ::page-cards in a section index, theme frontmatter fields, ::callout for the status marker.
  • Prose is not rewritten. This is a contract fix. Hand-written content stays as it is, word for word, except where a rule above touches it.
  • Language en, unchanged.

Alternatives considered

Dropping docs.render again and staying portable. Rejected: duxt is the declared rendering target for this estate's docs trees, and kirchDev/duxt's own tree already sits in that contract — it is the reference for what the result should look like.

Additional context

Counts at the time of writing: 5 markdown pages, 3 with relative .md links, 0 ::page-cards, 0 ::callout.

Acceptance: no page carries a body H1, doc links are absolute, section indexes use ::page-cards, the status marker uses ::callout, and a diff shows no prose change beyond what those rules require.

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