Skip to content

Draft: [doc] README improvements

Grant requested to merge doc-readme into main

Badges

  • Matrix
  • Discord
  • Lemmy !canvas@toast.ooo
  • Mastodon @canvas@fediverse.events
  • Donate

Sections

  • Screenshots
  • "What is Canvas?" / Motivation
  • Features
  • Roadmap
  • Contributing (CONTRIBUTING.md / SECURITY.md)
  • Deploying (DEPLOY.md)
  • Supporting/donations (SUPPORT.md)
  • Special thanks (r/Place, pxls, react-zoom-pan-pinch, NextUI, etc)
  • "What is sc07?"

Contributing

  • Development environment setup
  • Standard practices the repo uses
  • Layout of folders
  • Creating issues in the tracker
  • Reporting of security issues (SECURITY.md)
  • Development community (meta channels on matrix/discord)
  • sc07 GitLab registration information
  • CI/CD information

Deploying

  • Environment variables
  • docker-compose.yml
  • Considerations while deploying
  • Development community (meta channels)

Supporting

  • Stripe
  • sc07.shop
Edited by Grant

Merge request reports

Loading