Skip to content

Conversation

@f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Nov 25, 2025

Description

This PR updates the versions of the software:

  • Hugo
    • From
      • Version: 0.147.5
    • To
      • Version: 0.152.2 (latest supported by Blowfish v2.92.0)
  • Blowfish theme
    • Fast-forwarded from
      • Version: v2.86.0
      • Commit ID: 0b06a64139beba6287e7685f4c810ad4ff772fde
      • Timestamp: Tue May 27 01:03:33 2025 +0100
    • Fast-forwarded to
      • Version: v2.92.0
      • Commit ID: 81f0e887100f4ddc9856c6d662883b62ab7b1043
      • Timestamp: Mon Nov 3 22:34:25 2025 +0000

Fixes and improvements from incorporating the Blowfish updates

Incorporating the upstream changes to overridden files brought the following benefits:

  • Article cards on the main page don't have random gaps on the bottom edges anymore
  • Long summaries in article cards are now trimmed (with ellipses) to the size of the card
  • On the right side of the website header, the gap is removed between the right border and buttons/menus
  • While scrolling down in an article, the button Scroll to top now appears in the bottom-right corner
  • The TOCs to the right from an article content have a scroll bar now if the TOC is too long

Other improvements

  • Added badges to README for minimum and maximum supported Hugo versions
  • Removed unused overridden files
  • Improved Kapa widget welcome message
  • Refactored our overrides to BLowfish upstream files

Background information

As you might know, the espressif/blowfish repo is added to our developer-portal repo as a submodule in the folder themes/blowfish/. Over time, we copied a few Blowfish layout files from themes/blowfish/layouts/ to layouts/ and applied some changes. Comparing the files in themes/blowfish/layouts/ with our overridden versions in layouts/ revealed considerable updates in the former (submodule).

We usually fast-forward the Blowfish submodule changes once in a few months and only incorporate the upstream changes from themes/blowfish/layouts/ into respective overridden files if the website fails to build or if we discover critical issues. One of such issues was non-functioning burger menu button fixed in PR #362.

Although, skipping incorporation of non-critical upstream changes saves our time, it leads to accumulating maintenance debt. Ideally, we need to incorporate the upstream changes to our overriden files at least once a year.

I decided to partially incorporate the upstream changes as this will help us better prepare for implementing our own updates planned for the near future, such as adding the Dark theme and improving the main page.

This time, I did the following:

  • Extracted our changes by comparing the layouts/ files with their repective copies in themes/blowfish/layouts/ at the time of applying these changes
  • Applied the extracted changes to the layout files in Blowfish: v2.92.0. This task usually requires considerable efforts in figuring out how to implement the changes as simple copying and pasting is usually not possible.
  • Moved some code in overrides to custom partials for better maintainability

As a result, the following files have been updated:

  • layouts/partials/article-link/card-related.html
  • layouts/partials/article-link/card.html
  • layouts/partials/footer.html
  • layouts/partials/head.html
  • layouts/partials/header/basic.html
  • layouts/partials/hero/basic.html
  • layouts/partials/toc.html (removed as it has no overrides)
  • layouts/_default/baseof.html
  • layouts/_default/single.html

With these updates, the website builds stably. No major bugs have been identified so far.

Related

Testing

The changes have been compared visually to the existing online version and a number of local tests were done.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow force-pushed the chore/update-hugo-theme-to-latest-upstream branch 3 times, most recently from 987b96d to 84b8829 Compare December 10, 2025 11:28
@f-hollow f-hollow force-pushed the chore/update-hugo-theme-to-latest-upstream branch from 84b8829 to 9200efa Compare December 11, 2025 10:12
@f-hollow f-hollow force-pushed the chore/update-hugo-theme-to-latest-upstream branch from 9200efa to a700030 Compare December 12, 2025 06:32
@f-hollow
Copy link
Collaborator Author

@pedrominatel PTAL.

I updated the ChatBot welcome message as we agreed some time ago. Please double check it.

@f-hollow f-hollow force-pushed the chore/update-hugo-theme-to-latest-upstream branch from 31451a9 to 34b2e31 Compare December 12, 2025 09:31
@f-hollow f-hollow force-pushed the chore/update-hugo-theme-to-latest-upstream branch from 34b2e31 to 24d8f7b Compare December 12, 2025 09:38
@github-actions
Copy link

🎉 A preview for this PR is available at: https://preview-developer.espressif.com/pr599/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant