Skip to content

Add glossary for domain-specific terminology #201

@jtdub

Description

@jtdub

Description

The codebase and documentation use many domain-specific terms without a central definition. Terms like these appear throughout the code and docs but are only explained in context (if at all):

  • Sectional overwrite / sectional overwrite no negate
  • Idempotent command / idempotent command avoid list
  • Negation prefix / negation default when / negate with
  • Indent adjust
  • Sectional exiting
  • Per-line sub / full-text sub
  • Tag rules / match rules
  • Parent allows duplicate child

Proposed Improvement

Add a docs/glossary.md page that defines each term concisely with a brief example. This would:

  • Help new users understand driver configuration without reading 650 lines of drivers.md
  • Serve as a quick reference for contributors
  • Reduce the need to repeat definitions across multiple doc pages

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions