Repository navigation
docs(project): update the documentation for the Part 1 delivery - #11
Merged
Merged
Conversation
This was referenced Oct 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📝 Description
--config Release), the client finds its assets from any working directory, controls table (keyboard and gamepad), note that the client does not talk to the server yet.Packet, packet types, shared components,PacketError). The networking section leaves the Wrecks page; the Wrecks ECS example declaresATTRIBUTES, andSequenceContaineris listed under utilities. Index, architecture diagrams and technical study now show Protecs.EntityPositionis now type 1), newu16andbits64types. Layouts checked by serializing real packets with Protecs2da1ef9.ThreadQueue, players,PacketErrorhandling, updated next steps.🎯 Why is this change needed?
The documentation is graded at the Part 1 defense and described code that changed today.
Closes #10
🧩 Impacted component
server(Multiplayer & game logic)client(Graphical game)ECS(Wrecks engine)ci(GitHub Actions / Hooks)docs(Documentation)🧪 How to test manually?
python3 -m venv .venv && .venv/bin/pip install -r requirements.txt.venv/bin/mkdocs build --strictpasses with no warning.venv/bin/mkdocs serveand read the Getting started, Protecs, Protocol, Client and Server pages✅ Author checklist
cmake --build build) and there is no compilation error. (mkdocs build --strict)feat(server): ...).