Skip to content

dcc-bigfred/docs

Repository files navigation

BigFred Documentation

Source for the BigFred documentation site.

Local preview

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Open http://127.0.0.1:8000 (English) or http://127.0.0.1:8000/pl/ (Polish).

Contents

Section Path (English)
User guide content/en/guides/
Technical specification content/en/specs/
Related hardware & decoders content/en/related/
Coding standards (developers, not in MkDocs) coding-standards/

Polish translations live under content/pl/ (same paths). English is the source of truth; keep pl/ in sync when editing docs (see .cursor/skills/docs-i18n/SKILL.md).

About

BigFred website and docs

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors