summaryrefslogtreecommitdiff
path: root/docs/index.rst
AgeCommit message (Collapse)Author
2026-06-30docs: move changelog to docs/changelog, drop the docs/info folderhathach
Relocate docs/info/changelog/ -> docs/changelog/ (docs/info held only the changelog) and update all references: the toctree, README + MAINTAINERS links, make_release.py, and the make-release skill. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-30docs: keep the changelog page last in the toctree (maintainers before it)hathach
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-30Revert MAINTAINERS to .rst and add it to the docs buildhathach
- restore MAINTAINERS.rst (drop the .md); make the changelog link absolute so it resolves both on GitHub and in the rendered docs - docs/maintainers.rst includes the root file (same pattern as README) and is wired into the Documentation toctree Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-29Bump version to 0.21.0; rework changelog, contributors, and docshathach
Release: - Bump version to 0.21.0 and regenerate tusb_option.h, library.json, repository.yml, sonar-project.properties, boards.rst, dependencies.rst - Add 0.21.0 release notes and split the changelog into per-release files under docs/info/changelog/ (date out of title, driver/class groups as sub-headings, DCD & HCD section after Device/Host stacks) Contributors: - Credit each release's PR authors in a Contributors section - Drop the curated contributors page; add MAINTAINERS.rst Docs: - Update Code of Conduct to Contributor Covenant 3.0 (keep it in the repo, remove it from the built docs) - Sidebar: add a home entry, rename the group to "Documentation", move Changelog into it, add a GitHub Sponsor button, merge external links, rename FAQ; hide the inline toctree on the landing page - Add the make-release skill and update the AGENTS.md release process Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-29docs: add build-doc tooling and a README for every examplehathach
Documentation tooling: - Add the `build-doc` skill and `tools/build_doc.py` wrapper for local Sphinx builds (clean / -W / open). - Enable Markdown (MyST) in conf.py and auto-collect examples/{device,host,dual}/*/README.md into a 3-level Examples nav (Examples > Device/Host/Dual > example), noting each page's source location and normalizing headings to a single H1. - Remove the stale `.claude/commands/build-doc.md`; point the AGENTS.md Documentation section at the skill. Example docs: - Add a README.md for every device/host/dual example: what it does, USB interface table, notable tusb_config.h settings, generic CMake + Make build steps, and how to try it. - Fold each *_freertos variant into its base README, noting the FreeRTOS source path and any RTOS-specific behavior. Generated docs/examples/ output is git-ignored. Builds clean with `sphinx-build -W`. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
2025-11-11update dochathach
2025-10-20more consolidationc1570
2025-10-20rearrage TOCc1570
2025-10-20WIP improved docs (feat. LLM)c1570
2024-12-27update docs, remove uses.rst, structure.rst. Refactor docs, use README.rst ↵hathach
for docs index.rst
2024-12-27docs index.rst pointed to README.rsthathach
2021-07-30docs: update main indexperigoso
Signed-off-by: perigoso <[email protected]>
2021-07-30docs: setup sphinx docsperigoso
Signed-off-by: perigoso <[email protected]>