From 461dff59119addc8df38fca6189a2b691c77dedc Mon Sep 17 00:00:00 2001 From: hathach Date: Tue, 30 Jun 2026 10:57:26 +0700 Subject: Fix code-review findings (changelog rendering, release skill, sidebar) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - changelog: fix 3 silent RST mis-renders carried over from the old monolith — Markdown link in 0.7.0, mismatched/single backticks in 0.18.0 / 0.20.0 - make-release skill contributors one-liner: parallelize the gh fetch, anchor the bot filter (was a substring that dropped handles like "abbott"), and join with ", " (paste -sd cycles the delimiter -> "@a,@b @c"); finalize now stages only the reviewed set (git add -A -- ':!.idea'); drop the obsolete CRLF gotcha - make_release.py: emit LF not CRLF in the repository.yml insertion (fixes the gotcha at the source) - docs sidebar: drop the hardcoded furo component list; override brand.html to include furo's own template + the sponsor button (decoupled from furo internals, no upper-bound pin needed); move sponsor styles into custom.css - .pre-commit-config.yaml: drop stale end-of-file-fixer excludes for the deleted contributors/CoC include shims Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/_static/custom.css | 10 ++++++++++ docs/_templates/sidebar/brand.html | 11 +++++++++++ docs/_templates/sidebar/sponsor.html | 8 -------- docs/conf.py | 13 ------------- docs/info/changelog/0.18.0.rst | 2 +- docs/info/changelog/0.20.0.rst | 2 +- docs/info/changelog/0.7.0.rst | 2 +- 7 files changed, 24 insertions(+), 24 deletions(-) create mode 100644 docs/_templates/sidebar/brand.html delete mode 100644 docs/_templates/sidebar/sponsor.html (limited to 'docs') diff --git a/docs/_static/custom.css b/docs/_static/custom.css index d64d26047..ee187e945 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,3 +1,13 @@ .clear-both { clear: both; } + +.sidebar-sponsor { + display: flex; + justify-content: center; + padding: 0.4rem var(--sidebar-item-spacing-horizontal) 0.6rem; +} +.sidebar-sponsor iframe { + border: 0; + border-radius: 6px; +} diff --git a/docs/_templates/sidebar/brand.html b/docs/_templates/sidebar/brand.html new file mode 100644 index 000000000..ad0cae989 --- /dev/null +++ b/docs/_templates/sidebar/brand.html @@ -0,0 +1,11 @@ +{# Override furo's sidebar brand: keep the original (logo, links home), then add + a GitHub Sponsors button just below it. Using "!sidebar/brand.html" includes + the theme's own template, so we don't re-list furo's sidebar components and + stay decoupled from furo's internal layout. #} +{% include "!sidebar/brand.html" %} +
+ +
diff --git a/docs/_templates/sidebar/sponsor.html b/docs/_templates/sidebar/sponsor.html deleted file mode 100644 index db066a76c..000000000 --- a/docs/_templates/sidebar/sponsor.html +++ /dev/null @@ -1,8 +0,0 @@ -{# GitHub Sponsors button, shown just below the logo in the sidebar. #} -
- -
diff --git a/docs/conf.py b/docs/conf.py index 7f670f082..c6d04bff5 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,19 +43,6 @@ html_favicon = 'assets/logo.svg' html_theme_options = { 'sidebar_hide_name': True, } -# Furo default sidebar with a Sponsor button inserted just below the logo. -html_sidebars = { - '**': [ - 'sidebar/brand.html', - 'sidebar/sponsor.html', - 'sidebar/search.html', - 'sidebar/scroll-start.html', - 'sidebar/navigation.html', - 'sidebar/ethical-ads.html', - 'sidebar/scroll-end.html', - 'sidebar/variant-selector.html', - ] -} html_static_path = ['_static'] html_css_files = ['custom.css'] diff --git a/docs/info/changelog/0.18.0.rst b/docs/info/changelog/0.18.0.rst index cb10265b1..05dfd0579 100644 --- a/docs/info/changelog/0.18.0.rst +++ b/docs/info/changelog/0.18.0.rst @@ -12,7 +12,7 @@ New MCUs - Better support dcache, make sure all usb-transferred buffer are cache line aligned and occupy full cache line - Build ARM IAR with CircleCI -- Improve HIL with `dual/host_info_to_device_cdc`` optional for pico/pico2, enable dwc2 dma test +- Improve HIL with ``dual/host_info_to_device_cdc`` optional for pico/pico2, enable dwc2 dma test API Changes ----------- diff --git a/docs/info/changelog/0.20.0.rst b/docs/info/changelog/0.20.0.rst index 503d1c14e..d5952a830 100644 --- a/docs/info/changelog/0.20.0.rst +++ b/docs/info/changelog/0.20.0.rst @@ -68,7 +68,7 @@ Audio ^^^^^ - Add UAC1 support -- Implement RX FIFO threshold adjustment with `tud_audio_get/set_ep_in_fifo_threshold()` +- Implement RX FIFO threshold adjustment with ``tud_audio_get/set_ep_in_fifo_threshold()`` CDC ^^^ diff --git a/docs/info/changelog/0.7.0.rst b/docs/info/changelog/0.7.0.rst index 36fde9be5..664b323c8 100644 --- a/docs/info/changelog/0.7.0.rst +++ b/docs/info/changelog/0.7.0.rst @@ -53,7 +53,7 @@ USB Device USBD ^^^^ -- Add new class driver for **Bluetooth HCI** class driver with example can be found in [mynewt-tinyusb-example](https://github.com/hathach/mynewt-tinyusb-example) since it needs mynewt OS to run with. +- Add new class driver for **Bluetooth HCI** class driver with example can be found in `mynewt-tinyusb-example `__ since it needs mynewt OS to run with. - Fix USBD endpoint usage racing condition with ``usbd_edpt_claim()``/``usbd_edpt_release()`` - Added ``tud_task_event_ready()`` and ``osal_queue_empty()``. This API is needed to check before enter low power mode with WFI/WFE - Rename USB IRQ Handler to ``dcd_int_handler()``. Application must define IRQ handler in which it calls this API. -- cgit v1.3.1