- Group hub-documentation into explanation/, how-to/, and reference/ per Diátaxis - Move ifs-integration.md to new hoist-hub/ category - Add contributing/ category with Diátaxis framework explainer - Move tutorial-basics and tutorial-extras under docusaurus-guide/ - Rewrite docs/intro.mdx as site entry point with category navigation - Update all doc titles to reflect their Diátaxis type - Add HOIST logo to homepage hero and fix Get Started link
1.6 KiB
sidebar_position, title
| sidebar_position | title |
|---|---|
| 4 | Change Log |
Change Log
:::danger Very Important This section is exclusively for recording all subsequent changes to the delivered HUB feature, encompassing change requests, requirement misunderstandings, and bug fixes. :::
Each change — whether a change request, requirement misunderstanding, or bug fix — must be documented as a new entry with the same level of detail as the original Sub-Function section of the specification. The original Sub-Function section must remain unchanged to ensure the initial requirements remain visible.
Every entry should provide:
- A concise, high-level explanation of the reason for the modification
- The affected design sections, using clear tags or markers to highlight changes in lengthy specifications
- An explicit indication of whether the entry addresses a bug fix, a requirement misunderstanding, or a customer-requested change
Document Revision History
| Revision | Date | Author | Remarks |
|---|---|---|---|
| 1 | 2026-03-17 | Najib El-Husseini | Initial Draft |
Detailed Description — Change #1
Take the required sections from the Business Requirements Definition, Functional Design Definition, and Technical Design Definition to properly document the full change to this HUB feature. Include new test plans for the updated functionality.
Detailed Description — Change #n
Take the required sections from the Business Requirements Definition, Functional Design Definition, and Technical Design Definition to properly document the full change to this HUB feature. Include new test plans for the updated functionality.