Additional documentation cleaning #92
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates and significantly expands the project documentation for GenPRES, focusing on clarifying the technical stack, directory structure, architectural design, and the relationships between core domain libraries. The changes improve accuracy, add references to detailed specifications, and make the documentation more approachable for both new and experienced contributors.
Key documentation improvements:
General updates and corrections:
DEVELOPMENT.md, adding missing libraries, correcting descriptions, and grouping related modules more logically. [1] [2]Architecture and domain model documentation:
docs/mdr/design-history/architecture.mdto clarify the transformation pipeline (Free Text → OKRs → Order Scenarios → Quantitative Solutions), domain concepts, and the role of constraint-based calculation.File and library references:
Reference and navigation improvements:
These changes collectively make the documentation more accurate, navigable, and useful for developers working on or onboarding to the GenPRES project.
Most important changes by theme:
1. Technology stack and directory structure
DEVELOPMENT.md, adding missing modules, correcting names, and clarifying the purpose of each library. [1] [2]2. Architecture and domain model documentation
architecture.mdto clarify the transformation from free text to executable orders, and referenced detailed specifications for rules, order models, and constraint solving.3. Documentation navigation and references