The HardFOC portal: what HardFOC is, how its repositories fit together, every public repository with its documentation, and where to start with each board.
Site: https://hardfoc.github.io/
- Introduces HardFOC and its two boards, Vortex V1 and Flux V1.
- Shows the four layers (chip drivers, core, board HALs, products) and how they are pinned together.
- Lists every public repository as a card with its description, topics, documentation and latest release,
generated from the GitHub API and
org/org-metadata.jsonat every publish, and filterable by text or topic. - Gives a getting-started path per board, and for a chip driver on any MCU.
- Links the contribution rules and the private vulnerability report.
pip install "git+https://github.com/hardfoc/hf-general-ci-tools@v1#subdirectory=packages/hardfoc-mkdocs-theme"
GH_TOKEN=$(gh auth token) python3 tools/portal/catalogue.py # writes build/portal/catalogue.md
mkdocs serve # http://127.0.0.1:8000The site is unversioned: .github/workflows/docs.yml calls ru-mkdocs-publish.yml from
hf-general-ci-tools with versioning: false, and a push
to main (or the daily run) publishes the built site as the whole gh-pages branch.
| Page | What it covers |
|---|---|
| Get started | A path per board, and for a chip driver on your MCU |
| Repositories | Every public repository, searchable |
| Architecture | The layers and how they are pinned |
| Contribute | Issues, pull requests, vulnerability reports |
python3 -m unittest discover -s tests && mkdocs build --strictSee LICENSE.