Code Monkey home page Code Monkey logo

docs's Introduction

Spacebar Docs

Build to GitHub Pages Netlify Status code style: prettier

Deploy with Vercel

How to get started

  1. Fork this repository.

  2. Clone the forked repository.

    git clone https://github.com/<YOUR_USERNAME_HERE>/docs
  3. Install dependencies.

    python3 -m pip install -r requirements.txt
  4. Edit documents(s).

    • Format document(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.

  5. Test locally.

    • Serve in http://127.0.0.1:8000 with hot reload:

      python3 -m mkdocs serve
    • Build for production:

      python3 -m mkdocs build
  6. Commit changes with good commit messages.

  7. Create a pull request.

docs's People

Contributors

atoska21 avatar beerproductions avatar ben-d-anderson avatar bitfl0wer avatar chrischrome avatar developomp avatar erkinalp avatar featyre avatar fsg-cat avatar imaaronfr avatar jkosixtyfour avatar logkos avatar maddyunderstars avatar mugman174 avatar puyodead1 avatar ripples1253 avatar samuelscheit avatar stilic avatar thearcanebrony avatar thekrafter avatar xenorio avatar xnacly avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

docs's Issues

Tutorial for PM2 support?

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.

Contribution guide

  • 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?

Consistent branding

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.