74e5ceaf4d
- 修正文件名 XMOS_EQ_HID_Protoco.md -> XMOS_EQ_HID_Protocol.md - 新增 XMOS EQ HID 协议文档（中/英） - 精简免开发固件页「待发布」占位说明措辞 - mkdocs 预留（注释）数字调音台导航项 - gitignore 忽略未纳入版本库的 digital_mixer 目录 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
binbash Leverage™ Documentation
Overview
This repository contains all files used to create binbash Leverage Reference Documentation
Branches
master--> contains the source codegh-pages--> deployable (builded) version
Deployed Documentation
Check it out here.
Development / Contributing
- Clone the repo locally
- Config your MkDocs env including the navigation tree directory via
mkdocs.ymlfile. - Spin up your MkDocs local dev web server environment (
http://localhost:8000) (real time updates we'll be shown) (docker daemon needed) viaMakefilecmd
make init-makefiles # needed only the first time
make docs-live
- Update necessary
*.mdfiles inside thedocs/folder and check your updates through the local environment browser - And create your PR from
BBL-XXXtomasterbranch. - The Github Pages site https://leverage.binbash.co will be automatically deployed
via CircleCI job to the
gh-pagesbranch (currently being built from this branch).- It currently uses the
make docs-deploy-ghcmd which could be locally executed if needed too.
- It currently uses the
TODO
- Several sections needs completion or update.
About Diagrams
Some of them have editable version under docs/assets/diagrams/editable.
Others are directly exported from https://docs.google.com/presentation/d/1t2SWgWlGvuIOqYHkpzxQSVLafI_MCsA3gNz6Kkyf6TE/edit#slide=id.p6.