Commit Graph

19 Commits

Author SHA1 Message Date
d3597bc8c9 feat: enhance data model documentation with detailed entity descriptions and relationships 2025-11-12 18:17:39 +01:00
747f430562 fix: update database initialization and seeding instructions in installation guide 2025-11-12 18:17:20 +01:00
c9ac7195c7 feat: add continuous integration and deployment documentation, including CI stages, local testing, and Kubernetes deployment guidelines 2025-11-12 12:04:25 +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
02906bc960 Add dashboard layout plan and scenario validation rules documentation 2025-11-10 08:27:49 +01:00
f20ac85310 Add import/export file format guidelines to FR-008 2025-11-10 08:27:26 +01:00
e573f7dc7b Add import/export field mapping for Project and Scenario attributes in FR-008 2025-11-10 08:25:56 +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
5536f2325a Add instructions for seeding default accounts and roles in installation guide 2025-11-10 08:24:19 +01:00
1337bde936 Add references section to FR-001 for related documentation 2025-11-09 17:25:47 +01:00
eaab1c5a5e Fix links in documentation for LICENSE and related sections 2025-11-09 13:22:26 +01:00
423406ce20 Add initial API documentation placeholder 2025-11-09 13:18:27 +01:00
283cb132fa Add installation guide for Calminer with Docker setup instructions 2025-11-09 13:18:05 +01:00
598307674e Add initial documentation files: CHANGELOG.md, FAQ.md, and User Guide 2025-11-09 13:17:57 +01:00
d6b75490c6 Add architecture decisions document 2025-11-09 13:17:37 +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
913746b21d Update link to functional requirements document in introduction and goals 2025-11-09 11:42:10 +01:00
bdac2bab01 rename requirements.md to README.md 2025-11-08 19:54:09 +01:00
ad56c3c610 Initialize project documentation
Add architecture documentation and functional requirements for Calminer project

- Created Building Block View (05_building_block_view.md) detailing system architecture and component interactions.
- Developed Runtime View (06_runtime_view.md) outlining key user scenarios and interactions within the system.
- Established Deployment View (07_deployment_view.md) describing the infrastructure and mapping of building blocks to deployment components.
- Added README.md for architecture documentation structure.
- Introduced functional requirements (FR-001 to FR-010) covering scenario management, data import/export, reporting, user management, and collaboration features.
- Included templates for documenting requirements to ensure consistency across the project.
2025-11-08 19:49:07 +01:00