SethFalco/matrix-stream-alerts
Watch
1
Code Issues 5 Pull requests Projects Releases Packages Activity Actions

Finish writing the README/documentation/manual #4

New issue
Open
opened 2025-09-01 10:42:50 +01:00 by Ghost · 1 comment
Ghost commented 2025-09-01 10:42:50 +01:00 (Migrated from codeberg.org)
Copy link

We need to finish writing all help guides to configure and use the bot.

  • This includes a summary of what it does, with some attractive visuals.
  • Concise documentation on configuration properties and commands.
  • Verbose documentation on how to configure the bot end-to-end.

For the verbose documentation, this will be written in a manual style. As the setup for the project is very involved, we should help beginners to self-hosting with navigating it.

We won't write about everything, but we should go in a lot of depth, and link to hand-picked resources for further reading.

For my own reference:

  • Remember to cover that the access tokens copied from Matrix clients like Element are not the same as the ones output by matrix-bot-sdk. One has a refresh token set which causes the access token to expire in 12 hours, while the other last until revoked. Guide users on how to use our utility to generate the access token, or alternatively make an init function which interactively builds the config for the user.
We need to finish writing all help guides to configure and use the bot. * This includes a summary of what it does, with some attractive visuals. * Concise documentation on configuration properties and commands. * Verbose documentation on how to configure the bot end-to-end. For the verbose documentation, this will be written in a manual style. As the setup for the project is very involved, we should help beginners to self-hosting with navigating it. We won't write about _everything_, but we should go in a lot of depth, and link to hand-picked resources for further reading. For my own reference: * Remember to cover that the access tokens copied from Matrix clients like Element are not the same as the ones output by `matrix-bot-sdk`. One has a refresh token set which causes the access token to expire in 12 hours, while the other last until revoked. Guide users on how to use our utility to generate the access token, or alternatively make an `init` function which interactively builds the config for the user.
Ghost commented 2025-09-07 18:41:08 +01:00 (Migrated from codeberg.org)
Copy link

mentioned in merge request !19

mentioned in merge request !19
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
typescript
i18n
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
SethFalco/matrix-stream-alerts#4
No description provided.