Conversation
introduction, current status, datastructure, parents
There was a problem hiding this comment.
Pull request overview
Adds new documentation for Rooms and Boards to the Topics section, including a Rooms module overview and several Board module pages, and reorders the Topics sidebar positions to accommodate the new sections.
Changes:
- Added new “Rooms” topic with an overview page and a module-structure diagram.
- Added new “Boards” topic with introduction, column-board description, and technical details.
- Reordered various
docs/topics/**/_category_.jsonsidebar positions to reflect the new navigation structure.
Reviewed changes
Copilot reviewed 21 out of 22 changed files in this pull request and generated 20 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/topics/vue-client/category.json | Sidebar ordering change (position). |
| docs/topics/tsp-sync/category.json | Sidebar ordering change (position). |
| docs/topics/tools/category.json | Sidebar ordering change (position). |
| docs/topics/tldraw-server/category.json | Sidebar ordering change (position). |
| docs/topics/schulcloud-server/category.json | Sidebar ordering change (position). |
| docs/topics/schulcloud-client/category.json | Sidebar ordering change (position). |
| docs/topics/rooms/overview.md | New Rooms overview documentation (modules, roles, cross-school behavior). |
| docs/topics/rooms/img/rooms-structure.excalidraw.png | New Rooms diagram asset. |
| docs/topics/rooms/category.json | Adds Rooms topic category entry. |
| docs/topics/provisioning/category.json | Sidebar ordering change (position). |
| docs/topics/oauth/category.json | Sidebar ordering change (position). |
| docs/topics/moin-punkt-schule/category.json | Sidebar ordering change (position). |
| docs/topics/ldap/category.json | Sidebar ordering change (position). |
| docs/topics/h5p/category.json | Sidebar ordering change (position). |
| docs/topics/files-storage/category.json | Sidebar ordering change (position). |
| docs/topics/etherpad/category.json | Sidebar ordering change (position). |
| docs/topics/common-cartridge/category.json | Sidebar ordering change (position). |
| docs/topics/collabora/category.json | Sidebar ordering change (position). |
| docs/topics/board/technical-details.md | New technical details for board data model, authorization, websockets, and persistence. |
| docs/topics/board/introduction.md | New board module overview and status notes. |
| docs/topics/board/collumn-board.md | New column-board description and element list. |
| docs/topics/board/category.json | Adds Boards topic category entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… Events (#92) * add saga documentation * added events saga documentation
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 21 out of 22 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 21 out of 22 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/topics/rooms/overview.md
Outdated
| - The Rooms-API is the entrypoint for all Requests regarding the Room (note that the boards have their own API). Read more about [API Modules](../../backend-design-patterns/architecture.md#api-modules) for more information. | ||
|
|
||
| - The Room module is responsible for the Room object itself. It contains the configuration of the room, and references to all content That belongs to the room. | ||
|
|
||
| - The Room-Membership module is essentially a bridge between `Groups` and `Rooms`. It utilizes the `Groups` module to store the users of a room and their roles, while containing any user related logic specific to rooms. It's responsible to construct the `RoomAuthorizable.do`, which plays a major part in all authorization checks for the room. |
There was a problem hiding this comment.
Several wording/capitalization issues make this section harder to read (e.g., “entrypoint”, “Requests”, “content That”, and “It's responsible to construct …”). Consider using consistent sentence case and fixing the grammar (e.g., “entry point”, “requests”, “content that…”, “responsible for constructing …”).
docs/topics/rooms/overview.md
Outdated
|
|
||
| - The Boards are a feature that allows the creation and collaborative work on structured content. | ||
|
|
||
| - The Groups module provides an abstraction to store groups of users with their context-specific roles. Its used to store which roles a user has in what room. |
There was a problem hiding this comment.
Typo/grammar: “Its used” should be “It’s used” (or “It is used”).
| - The Groups module provides an abstraction to store groups of users with their context-specific roles. Its used to store which roles a user has in what room. | |
| - The Groups module provides an abstraction to store groups of users with their context-specific roles. It is used to store which roles a user has in what room. |
docs/topics/rooms/overview.md
Outdated
|
|
||
| Let's consider an example where `Teacher A` is owner of `Room A` at `School A`, and needs to add Users from `School B`. | ||
|
|
||
| `Teacher A` is not allowed to see or add `Student B` from the other school. He can however add `Teacher B` from the other school (if that teacher is publicly visible), and give him the RoomAdmin role. |
There was a problem hiding this comment.
In this example the role name is written as “RoomAdmin role”; elsewhere the doc uses “Room Admin”. Consider using a consistent role name to avoid confusion for readers.
| `Teacher A` is not allowed to see or add `Student B` from the other school. He can however add `Teacher B` from the other school (if that teacher is publicly visible), and give him the RoomAdmin role. | |
| `Teacher A` is not allowed to see or add `Student B` from the other school. He can however add `Teacher B` from the other school (if that teacher is publicly visible), and give him the Room Admin role. |
Description
Links to Tickets or other pull requests
Screenshots of UI changes
Approval for review