MyDigiTwin

Overview

This repository contains the architecture documentation for the MyDigiTwin project, based on arc42, a lightweight template for documenting software architectures. The documentation is written in Markdown format, with each section contained in its own file. The documentation can be built and viewed using MkDocs, a static site generator.

Table of Contents

1. Introduction and Goals
2. WIP - Architecture Constraints
3. WIP Context and Scope
4. WIP Solution Strategy
5. Building Block View
6. WIP Runtime View
7. WIP Deployment View
8. WIP Cross-cutting Concepts
9. WIP Architecture Decisions
10. WIP Quality Requirements
11. Risks and Technical Debt
12. Glossary
13. About arc42

Automated documentation building

This repository includes a GitHub action script that builds the documentation as an HTML website and publishes it in GitHub pages. However, as this repository is currently private, the project's GitHub page won't be available.

Manual documentation building

To build and view the documentation locally, follow these steps:

1. Ensure you have Python and mkdocs installed on your system.
2. Clone this repository to your local machine.
3. Open a command prompt or terminal and navigate to the project directory.
4. Build the documentation by running the following command:

   mkdocs build
   

   This command generates a static HTML site in the site directory.
5. To view the documentation, run the following command:

   mkdocs serve
   

   This will start a local development server and provide a URL where you can access the documentation in your web browser.