View Code? Open in Web Editor
NEW
Docs for Spacebar
Home Page: https://docs.spacebar.chat
License: Other
docs's Introduction
Fork this repository.
Clone the forked repository.
git clone https://github.com/< YOUR_USERNAME_HERE> /docs
Install dependencies.
python3 -m pip install -r requirements.txt
Edit documents(s).
Spacebar uses prettier formatter to consistently format our documents. Instructions to install and use prettier can be found here .
If you are using vscode, install the prettier extension to automatically format documents on save.
Test locally.
Commit changes with good commit messages.
Create a pull request.
docs's People
docs's Issues
material-mkdocs --> mkdocs-material
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.
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)
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?
The fosscord icon and theme color was changed a while ago. I believe the docs page should reflect the changes too.
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.