8ee0372c93
- 产品固件下载改为入口页，提供「免开发固件下载」与「WiFi音箱EVB板」两个入口卡片 - 新增免开发固件下载页（zerocode_firmware.md），按核心模组系列铺开，已发布固件直接下载，其余以占位预留 - 新增 WiFi音箱EVB板固件下载页（wifi_speaker_evb.md），承载 RTL8711 平台基础固件与多通道配置固件 - 更新 mkdocs.yml 导航
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.