How do I create a component overview?

Table of Contents

See Component Documentation Guide for what each section should contain and what separates a useful entry from a placeholder.

Question

How do I create a component_overview.org for an ORE Studio component that is missing one?

Answer

./projects/ores.compass/compass.sh add component \
  --slug component_overview \
  --parent-dir projects/ores.<comp>/modeling \
  --title "ores.<comp>" \
  --description "<one-liner ≤ 120 chars>" \
  --brief "<short tagline that codegen reads from #+brief:>" \
  --tags "qt,component"   # adjust tags to match the domain

The script writes projects/<comp>/modeling/component_overview.org with a fresh UUID, today's dates, skeleton sections, and the codegen-readable scalars in frontmatter (#+name: derived from --title, #+full_name: equal to --title, #+brief: from --brief). Codegen reads these to scaffold the C++ + CMake project under projects/<full_name>/; the overview is the single source of truth for both humans and the generator (the standalone *_component.json / *_component.org files were retired by PR #1014).

The --brief flag defaults to --description when omitted, so short one-line components don't need to repeat themselves.

Then fill in each section (values in parentheses are prompts, not literal content):

  1. Summary — 3–5 sentences: what it does and why it exists.
  2. Inputs — named data sources (NATS subjects, DB tables, config).
  3. Outputs — what it produces (MDI windows, NATS messages, records).
  4. Entry points — 3–6 key file paths with a one-line annotation each.
  5. Dependenciesores.* slugs from the component's target_link_libraries block; omit ubiquitous transitive deps.
  6. See also — at minimum one id-link to a sibling component; more for knowledge docs and recipes. Use [[id:UUID][label]].

Finally, remove the component's MISSING_OVERVIEW entry from projects/ores.codegen/docs_exceptions.txt and run the validation:

./projects/ores.codegen/validate_docs.sh

Script

./projects/ores.compass/compass.sh add component — delegates to the Mustache-based document generator. Full CLI reference at projects/ores.codegen/docs/doc_generator.md.

Tested by

Manual: run validate_docs.sh after creation and confirm no MISSING_OVERVIEW errors remain for the target component.

See also

Emacs 29.1 (Org mode 9.6.6)