-
Notifications
You must be signed in to change notification settings - Fork 0
[Feature]: Need docs/design/introduction.md #9
Description
Problem Statement
The docs/design/introduction.md needs to be created covering the high-level design software units.
Proposed Solution
A good example of a design-introduction can be found at https://raw.githubusercontent.com/demaconsulting/ReqStream/refs/heads/main/docs/design/introduction.md and includes the key elements of the Software Structure and Folder Layout.
Don't write what's in the repository now, but write the software structure and folder layout as it would appear in the finished project. Plan the final implementation including the Software-System, Software-Subsystems, and Software-Units (see your own standards document for definitions at https://raw.githubusercontent.com/demaconsulting/FileAssert/refs/heads/main/.github/standards/software-items.md)
Alternatives Considered
No response
Usage Examples
Benefits
The design introduction will be used as guidance for implementation.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
Checklist
- I have searched existing issues to ensure this is not a duplicate
- I have provided a clear description of the feature
- I have explained why this feature would be useful