8 Commits

Author SHA1 Message Date
4dea0a9ae1 Add detailed SQLAlchemy models, navigation metadata, enumerations, Pydantic schemas, monitoring, and auditing documentation
- Introduced SQLAlchemy models for user management, project management, financial inputs, and pricing configuration.
- Created navigation metadata tables for sidebar and top-level menus.
- Cataloged enumerations used across ORM models and Pydantic schemas.
- Documented Pydantic schemas for API request/response validation, including authentication, project, scenario, import, and export schemas.
- Added monitoring and auditing tables for performance metrics and import/export logs.
- Updated security documentation to reflect changes in data model references.
2025-11-13 20:23:09 +01:00
07e68a553d Enhance documentation for data model and import/export processes
- Updated data model documentation to clarify relationships between projects, scenarios, and profitability calculations.
- Introduced a new guide for data import/export templates, detailing CSV and Excel workflows for profitability, capex, and opex data.
- Created a comprehensive field inventory for data import/export, outlining input fields, derived outputs, and snapshot columns.
- Renamed "Initial Capex Planner" to "Capex Planner" and "Processing Opex Planner" to "Opex Planner" for consistency across user guides.
- Adjusted access paths and related resources in user guides to reflect the new naming conventions.
- Improved clarity and consistency in descriptions and instructions throughout the user documentation.
2025-11-13 14:10:47 +01:00
fb6be6d84f feat: add functional requirements for profitability, Monte Carlo simulation, and Capex/Opex management; enhance user guide with planners 2025-11-13 09:20:10 +01:00
d3597bc8c9 feat: enhance data model documentation with detailed entity descriptions and relationships 2025-11-12 18:17:39 +01:00
29f16139a3 feat: documentation update
- Completed export workflow implementation (query builders, CSV/XLSX serializers, streaming API endpoints, UI modals, automated tests).
- Added export modal UI and client script to trigger downloads directly from dashboard.
- Documented import/export field mapping and usage guidelines in FR-008.
- Updated installation guide with export environment variables, dependencies, and CLI/CI usage instructions.
2025-11-11 18:34:02 +01:00
3d35e9ae60 Enhance security documentation with details on administrative credentials, credential reset process, route guard dependencies, and session management. 2025-11-10 08:25:38 +01:00
eaab1c5a5e Fix links in documentation for LICENSE and related sections 2025-11-09 13:22:26 +01:00
1af654de1f Add project documentation and architecture details
- Create .gitignore to exclude specific project files and directories.
- Add CONTRIBUTING.md with guidelines for contributing to the project.
- Update README.md to reflect changes in usage section and contact information.
- Introduce 08_concepts.md outlining cross-cutting concepts in the architecture.
- Add 02_data_model.md detailing the data model and relationships.
- Implement 03_security.md to describe security measures and practices.
- Establish 08_ui_design.md for user interface design principles.
- Document quality requirements in 10_quality_requirements.md.
- Identify risks and technical debts in 11_technical_risks.md.
- Create a glossary in 12_glossary.md for project-specific terms.
- Include about-arc42.md to explain the arc42 documentation template.
- Define price calculation variables and formula in price_calculation.md.
- Introduce ADR template in adr.md for documenting architecture decisions.
2025-11-09 13:17:19 +01:00