spacebarchat / docs Goto Github PK

Is your feature request related to a problem? Please describe.
I cannot tell if I can chat with users registered on other Spacebar instances without testing it myself.

Describe the solution you'd like
Adding an FAQ section called "is Spacebar federated?" or something similar.

Describe alternatives you've considered
N/A

Additional context
Interoperability is an important feature when self-hosting is involved to avoid creating user "bubbles" and overwhelming free instance hosters.

• How to create a new route
• How our schema/openapi stuff works
• How to send gateway events and what not to send (i.e. whole user obj vs PublicUser)
• How to set up a dev server and connect to it (hmmm cough cough?)
• How the server infra works? API and gateway communication for example. Maybe even future plans for gateway (guild nodes)
• How to write embed handlers? (for more sites)
• How to edit database models? Perhaps some gotchas with typeorm?
• How to add/use Config?

I've gotten Fosscord working with PM2 and I'd like to add it to the documentation, if using pm2 is actually a good practice in this case.

opencollective link still points to fosscord, should be https://opencollective.com/spacebar

May use something like this https://rapidocweb.com/examples/badges.html#overview
I.e. purple routes are spacebar only, blue is discord only.

spacebarchat/missing-routes/issues/1

https://docs.fosscord.com/contributing/ here is a mistake at the mongodb guide where it does say 1. 1. 1. 1. instead of 1. 2. 3. 4.

H3cJP#1817 on Discord pointed out, that the server repo is being cloned into "server/". The docs tell you to cd into "spacebar-server/" though, which doesn't exist.

The fosscord icon and theme color was changed a while ago. I believe the docs page should reflect the changes too.

https://docs.fosscord.com/contributing/
Does Not contain:
How to setup the CDN
How to setup the Gateway

.env is "outdated" if you use MongoDB compass to enter the endpoints in the Database (Which port and ws/http information missing)

• material-mkdocs --> mkdocs-material