Skip to content

[Docs/Examples] Demo repository is critically incomplete: Missing Frontmatter, Mainmatter, and Backmatter structure #6

@kylejtobin

Description

@kylejtobin

The current demo repository is insufficient for any real-world use case because it fails to demonstrate the fundamental architecture of the system: the separation and implementation of Frontmatter, Mainmatter, and Backmatter.

The Problem:
Production books require distinct sections for content like copyright pages, dedications, indices, and appendices. The current demo ignores these requirements entirely, presenting only a flat or undefined structure.

Impact on Users:
Because the demo does not validate or show how these three core sections are implemented:

  1. Structural Ambiguity: Users cannot determine how the system identifies the start or end of these sections, or if specific configuration is required to trigger them.
  2. Trial and Error: Users are forced to guess where to place standard components (e.g., is a copyright page treated as a chapter? Is an appendix a separate file type?), leading to wasted time and failed builds.
  3. Risk of Data Loss: Without knowing the correct structure, there is no way to know if files placed in the wrong "matter" will be ignored by the generator entirely.

Request:
Update the demo to explicitly include a working example that utilizes Frontmatter, Mainmatter, and Backmatter. The demo must prove that the system can correctly assemble a book with all three logical sections.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions