Documentation
Contributing
Overseer is developed in the open. Bug reports, features and documentation are all welcome.
Report a bug
Open an issue on GitHub with:
- what you expected and what happened,
- steps to reproduce,
- your OS, GPU and Python / Node versions.
Propose a feature
Open an issue describing the use case. Direction is shaped by real needs, so context helps.
Contribute code
- Fork and branch off
main. - Keep changes focused; match the surrounding style.
- Run the frontend type-check (
npm run checkinweb/) before opening a PR. - Open a pull request describing the change and how you verified it.
Improve the docs
This site is Markdown + Eleventy. To add a page:
website/src/docs/your-page.md
---
title: Your Page
order: 12
---
Your content in Markdown.
It appears in the sidebar automatically, ordered by order. Build locally with npm run dev in website/.
Thank you
Every issue, fix and doc improvement makes the platform better.