diff --git a/.gitignore b/.gitignore index 49611dd..3c559c3 100644 --- a/.gitignore +++ b/.gitignore @@ -103,3 +103,16 @@ $RECYCLE.BIN/ ## Jenv .java-version + +## diagrams.net / draw.io +# Draw.io temporary files +*.drawio.bkp +*.drawio.tmp + +# Auto-save files +*.drawio.autosave + +# Exported images (optional – nur wenn du Exporte nicht versionieren willst) +*.drawio.png +*.drawio.svg +*.drawio.pdf \ No newline at end of file diff --git a/README.md b/README.md index 01ffb96..59bdd50 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,9 @@ This protocol handles game state synchronization, player actions, lobby and glob │ └── test/ # Unit tests ├── documents/ # Project resources and documentation │ ├── images/ # Images for README and documentation -│ ├── docs # Documentation +│ ├── docs # Directory for diary and blog files +│ │ ├── diary # Diary files for each organizational meetup +| | └── blog # Blog files covering project-related topics │ ├── milestones/ # Milestone deliverables (6 milestones) │ └── (Other resources) # Additional project materials └── outreach/ # Public-facing content and marketing materials diff --git a/documents/docs/blog/README.md b/documents/docs/blog/README.md new file mode 100644 index 0000000..aa92b15 --- /dev/null +++ b/documents/docs/blog/README.md @@ -0,0 +1,28 @@ +# Blog + +## Purpose +This folder contains a collection of blog posts documenting the development process of our application. These blogs serve two key purposes: + +1. **For External Audiences** + + The blogs provide insights into the internal program flow and the interaction between components without requiring readers to dive into the source code. They offer a mixed-level overview of how different parts of the system work together. + +2. **For Our Team** + + The blogs serve as a record of our decision-making process. By documenting what decisions were made and why, we can track the evolution of our design choices and understand the reasoning behind them. This is invaluable for maintaining consistency across the team. + +But keep in mind that these blogs **do not replace** the detailed source code documentation. + +## Format +All blog posts follow the naming convention: `_.md` + +## Blog Posts + +### General +*(No posts yet)* + +### Client +*(No posts yet)* + +### Server +*(No posts yet)*