Skip to content

Commit

Permalink
docs: link to commands
Browse files Browse the repository at this point in the history
  • Loading branch information
jbrunton committed Sep 24, 2024
1 parent 2b14f7a commit d73737c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions services/api/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The domain is organised around these fundamental concepts:

- {@link domain/entities/messages/message | Messages} refer to the messages sent by users and by the system.

- {@link domain/entities/commands | Commands} refer to a specific type of message, a command, which will (when authorized) trigger a change to entities in the system (e.g. `/rename room My Room`).

- {@link domain/entities/rooms/room | Rooms} are the message rooms users may join, to which messages are sent.

- {@link domain/entities/memberships/membership | Memberships} represent the membership status history (`PendingApproval`, `Joined`, `Revoked`, etc.) of a user for a given room. This history is used to authorize users using an {@link domain/usecases/auth-service | AuthService}.
Expand Down

0 comments on commit d73737c

Please sign in to comment.