University-of-Basel-Studentprojects/Programmierprojekt
Archived
1
0
Fork 0
Code Issues 17 Pull Requests Actions Wiki Activity

Write documentation on how to handle requests serverside #49

New Issue
Closed
opened 2026-04-04 13:29:46 +02:00 by lars.winzer · 9 comments
lars.winzer commented 2026-04-04 13:29:46 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

Task

Summary

As of writing this task, there’s no central place where documentation is stored that outlines the components and their respective implementations for processing incoming requests.

JavaDoc doesn’t qualify as such documentation because it primarily aids during development rather than providing guidance on how to begin.

Context

Documentation

Current Progress

  • Create document providing overview for relevant documents for networking

  • Create a guide outlining the steps involved in handling your first request

    Inkluding the CommandParser, Request, CommandHandler, Response and registering each component in the composite root.

Checklist

  • I outlined checkpoints describing phases of my work related to this task
  • I added relevant labels
  • I linked to other issues or branches that must be completed first
## Task <!--The reccommended type is: Task--> ### Summary As of writing this task, there’s no central place where documentation is stored that outlines the components and their respective implementations for processing incoming requests. JavaDoc doesn’t qualify as such documentation because it primarily aids during development rather than providing guidance on how to begin. ### Context Documentation ### Current Progress - [x] Create document providing overview for relevant documents for networking - [x] Create a guide outlining the steps involved in handling your first request Inkluding the `CommandParser`, `Request`, `CommandHandler`, `Response` and registering each component in the composite root. ### Checklist - [x] I outlined checkpoints describing phases of my work related to this task - [x] I added relevant labels - [x] I linked to other issues or branches that must be completed first
lars.winzer commented 2026-04-04 13:29:54 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

assigned to @lars.winzer

assigned to @lars.winzer
lars.winzer commented 2026-04-04 13:30:38 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

created branch chore/49-serverside-documentation-for-handling-request to address this issue

created branch [`chore/49-serverside-documentation-for-handling-request`](/cs108-fs26/Gruppe-13/-/compare/main...chore%2F49-serverside-documentation-for-handling-request) to address this issue
lars.winzer commented 2026-04-04 14:20:10 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

added 35m of time spent at 2026-04-04 12:00:00 +0200

added 35m of time spent at 2026-04-04 12:00:00 +0200
lars.winzer commented 2026-04-04 14:38:01 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

added 35m of time spent at 2026-04-04 12:00:00 +0200

added 35m of time spent at 2026-04-04 12:00:00 +0200
lars.winzer commented 2026-04-04 14:38:13 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

marked the checklist item Create document providing overview for relevant documents for networking as completed

marked the checklist item **Create document providing overview for relevant documents for networking** as completed
lars.winzer commented 2026-04-04 16:19:01 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

added 1h 30m of time spent at 2026-04-04 12:00:00 +0200

added 1h 30m of time spent at 2026-04-04 12:00:00 +0200
lars.winzer commented 2026-04-04 18:10:17 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

marked the checklist item Create a guide outlining the steps involved in handling your first request Inkluding the CommandParser, Request, CommandHandler, Response and registering each component in the composite root. as completed

marked the checklist item **Create a guide outlining the steps involved in handling your first request&#10;Inkluding the CommandParser, Request, CommandHandler, Response and registering each component in the composite root\.** as completed
lars.winzer commented 2026-04-04 18:12:41 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

mentioned in merge request !76

mentioned in merge request !76
lars.winzer commented 2026-04-04 18:14:07 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

mentioned in commit 6d19b89351

mentioned in commit 6d19b8935130913a1ede1a1b3f6f5cfcf3ba4a40
lars.winzer (Migrated from git.scicore.unibas.ch) closed this issue 2026-04-04 18:14:07 +02:00
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
achievement
Tasks related to milestone achievements
 bug
Issues related to programming errors on both client and server
 ci
Issues related to problems with the gitlab ci (incorrect or missing jobs)
 client
Issues (To-Dos and tasks) related to the client
 commands
Issues and tasks related to commands and thier infrastructure (CommandHandler, CommandParser, ...)
 documentation
Issues related to the documentation (for new or unclear, incorrect or incomplete entries)
 enhancement
Issues related to enhancements (also known as feature-requests)
 game-engine
Issues related to the game engine (incorrect state transitions or move validations)
 linting
Issues related to linting i.e. false detections, too generous linting, ...
 messages
Issues and tasks related to the messages and chats
 network
Issues and tasks related to the network (SessionReader / SessionWriter, Parser, ResponseBody, ...)
 outreach
Issues and tasks related to the outreach website and everything directly related to it
 server
Issues (To-Dos and tasks) related to the server
 task
Issues outlining and discussing a general task or implementation
 templates
Issues related to GitLab templates
 ui
Issues and tasks related to the client-side ui
 unit-test
Issues related to missing or already planned unit tests
 user
Issues and tasks related to the user management
No Label commands documentation server task
Milestone
No items
No Milestone Milestone 4
Assignees
Clear assignees
lars-winzer (Lars Winzer)
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: University-of-Basel-Studentprojects/Programmierprojekt#49
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?