subsystem-md

Expected Input

Use the subsystem name supplied by the user as <subsystem-name>.

The subsystem documentation file is located at docs/subsystems/<subsystem-name>/README.md.

Check if this file exists:

• If it does not exist: Proceed to Initialization Mode
• If it exists: Proceed to Reconciliation Mode

---

Shared Guidelines

When drafting or updating this documentation, you

• MUST focus on the high-level aspects of the requested subsystem, ensuring that it provides clear insights into its functionality, design principles, and interactions with other parts of the system.
• MUST NOT include low-level implementation details, code snippets, or exhaustive technical specifications, as those may change frequently during development.
• MUST ensure that the documentation is accurate and reflects the current state of the requested subsystem as understood from your analysis of the codebase.
• MUST strike a balance between being comprehensive and concise, providing enough information to be useful without overwhelming the reader with unnecessary details.

Section Description Syntax: **<section-identifier>: <section-level>** { - section-title} - <section-description> { - section-example} {, section-example}...

Section Description Examples:

• **Subsystem Title: H1** - The name of the subsystem in Title Case.
• **Subsystem Tagline: N/A** - A brief, catchy tagline that summarizes the subsystem's purpose or mission.
• **Documented Version: N/A** - The current documented version of the subsystem. - **Documented Version**: v0.1.0, **Documented Version**: N/A
• **Design Principles: H2** - Design Principles - An explanation of the core design principles and architectural patterns.

The structure of the subsystem README.md file MUST include ONLY the following sections, in order:

1. Subsystem Title: H1 - The name of the subsystem in Title Case. Derive a suitable title based on the subsystem's purpose and functionality.
2. Subsystem Tagline: N/A - A brief, catchy tagline that summarizes the subsystem's purpose or mission.
3. Documented Version: N/A - The version of the requested subsystem being documented, derived from git tags or version files. If no versioning is found use "N/A". - **Documented Version**: v0.13.0, **Documented Version**: N/A
4. Last Updated: N/A - The date when the documentation was last updated. Use the format YYYY-MM-DD. - **Last Updated**: 2024-06-15
5. ToC: H2 - Table of Contents - A markdown table of contents that links to the subsequent header sections in the README.md.
6. Overview: H2 - Overview - A brief, high-level description of the requested subsystem, its purpose, goals, and key features.
7. Design Principles: H2 - Design Principles - An explanation of the core design principles and architectural patterns that guide the development of the requested subsystem.
8. Key Components: H2 - Key Components - A high-level description of the main components or modules that make up the requested subsystem.
9. Integration Points: H2 - Integration Points - An outline of how the requested subsystem integrates with other subsystems or components within the codebase.
10. Glossary: H2 - Glossary - Definitions of any specialized terms or concepts relevant to the requested subsystem.