Skip to content

Slice #22.3: Refresh dogfood example to current toolkit rules #25

Description

@dieterbaier

Parent: #22

Goal

Refresh example/ so it dogfoods the current architecture-knowledge-toolkit rules and generator behavior.

Findings From #22 Analysis

  • example/scripts/validate-metamodel.rb is older than the root script and lacks ChapterIncludeFragmentGenerator.
  • example/metamodel/*.yaml currently matches the root metamodel schemas.
  • example/templates/adr.adoc, example/templates/quality-scenario.adoc, and example/templates/risk.adoc currently match the root templates and therefore also carry the heading-level issue until the templates are fixed.
  • Several example chapter main files still manually maintain detail includes instead of using generated chapter include fragments:
    • example/src/docs/arc42/doc-01000-introduction-and-goals.adoc
    • example/src/docs/arc42/doc-09000-architecture-decisions.adoc
    • example/src/docs/arc42/doc-10000-quality-requirements.adoc
    • example/src/docs/arc42/doc-11000-risks-and-technical-debt.adoc
  • Example validation currently passes with no warnings, so drift is not detected.
  • Rendering the example shows ADR/QS/R artifacts as sibling chapters rather than children of their arc42 chapters.

Scope

  • Refresh copied example toolkit assets from the root toolkit where appropriate:
    • example/scripts/validate-metamodel.rb
    • example/templates/*.adoc
    • metamodel schemas if they change in related slices
  • Regenerate example generated fragments with the current generator.
  • Migrate example chapter main files to generated chapter include fragments and native TOC behavior where applicable.
  • Update example ADR/QS/R headings to the canonical == level.
  • Render the example assembled document and verify the hierarchy.

Acceptance Criteria

  • Example validation and generation use the same generator capabilities as the root toolkit.
  • Example chapter main files do not manually list detail artifacts where generated include fragments exist.
  • Example ADR/QS/R artifacts render below Chapters 9/10/11, not as top-level sibling chapters.
  • Example README remains accurate after the refresh.
  • Root and example validation/render checks pass.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions