tscord-docs

📃 Documentation for TSCord

Stars
2

TSCord Documentation

This repository contains the documentation for the TSCord project written with Docusaurus.

Versionning

The documentation is versioned using the versioning system of Docusaurus.

Command to create a new version:

npm run docusaurus docs:version X.X

Contributing

If you want to contribute to the documentation, you can do so by opening a pull request. You can also open an issue if you have any questions or suggestions.

Todo

  • A guide to resolve "common problems"
    • Docker build error -> mismatching node version used to generate package-lock.json
  • docs/devops/deploy -> list of deployment options (raspberry, VPS server, fly.io, render, railway, etc) with free and paid options
  • https://github.com/barthofu/tscord-docs/issues/3
  • Precise the use of .followUp instead of .reply
  • Write a real Introduction page (not just a c/p of the tscord README)
  • Rework the dark theme
  • "Other components" section (homepage)
    • Add a CLI section
    • Compress images