Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.3 KB

File metadata and controls

26 lines (17 loc) · 1.3 KB

Dashboard Documentation

Welcome to the full documentation for the Dashboard project.

Core Concepts

  • Architecture: An overview of the modular architecture and how the components work together.
  • Main Script (dashboard.sh): A detailed guide to the main runner script and its features.
  • Configuration: A comprehensive guide to all the settings in the config/config.sh file.
  • Output Formats: A reference for all supported output formats with examples.

Development

  • Installation: Step-by-step installation instructions.
  • Modules: A guide to how modules work and how to create new ones.
  • Testing: Information on the BATS testing framework and how to run the test suite.

Modules

  • Discord: Documentation for the Discord module.
  • GitHub Sponsors: Documentation for the GitHub Sponsors module.

Project

  • Future Plans: A look at the roadmap and planned features for the project.
  • GitHub Pages: Information on how this documentation is published as a website.