From 466bd327b8d6d08bc7918dd2f20ca4fb151b3f9c Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 30 Apr 2026 07:19:12 -0400 Subject: [PATCH 1/2] Prettierignore rule cleanup, and fix format of more pages - Scope: internal, docs (formatting) --- docsy.dev/.prettierignore | 19 +----- docsy.dev/content/en/_index.md | 17 ++++-- docsy.dev/content/en/docs/updating/_index.md | 10 ++-- .../en/docs/updating/updating-hugo-module.md | 6 +- .../en/docs/updating/updating-submodules.md | 58 +++++++++++-------- docsy.dev/content/en/search.md | 1 - .../blocks-cover/color-gradient/index.md | 19 ++++-- .../tests/blocks-cover/height-auto/index.md | 19 ++++-- .../tests/blocks-cover/height-full/index.md | 19 ++++-- .../en/tests/blocks-cover/height-min/index.md | 19 ++++-- .../en/tests/layouts/no-left-sidebar.md | 4 +- docsy.dev/tests/md-output/goldens/index.md | 11 ++-- 12 files changed, 116 insertions(+), 86 deletions(-) diff --git a/docsy.dev/.prettierignore b/docsy.dev/.prettierignore index 97cfed417..c11ae3c08 100644 --- a/docsy.dev/.prettierignore +++ b/docsy.dev/.prettierignore @@ -1,20 +1,5 @@ -# cSpell:ignore lookandfeel - -/content/**/*.* -!/content/en/about/**/*.* -!/content/en/blog/**/*.* -!/content/en/community/**/*.* -!/content/en/docs/_index.md -!/content/en/docs/best-practices/**/*.* -!/content/en/docs/content/**/*.* -!/content/en/docs/contributing.md -!/content/en/docs/deployment/**/*.* -!/content/en/docs/get-started/**/*.* -!/content/en/docs/language.md -!/content/en/examples/**/*.* -!/content/en/project/**/*.* -!/content/fr/**/*.* +/content/en/docs/updating/convert-site-to-module.md +/content/en/tests/alerts.md /layouts - /tests/md-output/goldens/**/*.* diff --git a/docsy.dev/content/en/_index.md b/docsy.dev/content/en/_index.md index f786b8ab3..48bc81c76 100644 --- a/docsy.dev/content/en/_index.md +++ b/docsy.dev/content/en/_index.md @@ -41,24 +41,31 @@ on creating great content for your users. [Hugo]: https://gohugo.io/ [netlify]: https://www.netlify.com/ -[netlify-badge]: https://www.netlify.com/img/global/badges/netlify-color-accent.svg +[netlify-badge]: + https://www.netlify.com/img/global/badges/netlify-color-accent.svg {{% /blocks/lead %}} {{% blocks/section color="primary" type="row" %}} {{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="examples/" %}} -As well as our example site, there's a growing number of projects using Docsy for their doc sites. -{{% /blocks/feature %}} +As well as our example site, there's a growing number of projects using Docsy +for their doc sites. -{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}} -We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome! {{% /blocks/feature %}} +{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}} + +We do a [Pull Request](https://github.com/google/docsy/pulls) contributions +workflow on **GitHub**. New users are always welcome! + +{{% /blocks/feature %}} {{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}} + Find out about new features and how our users are using Docsy. + {{% /blocks/feature %}} {{% /blocks/section %}} diff --git a/docsy.dev/content/en/docs/updating/_index.md b/docsy.dev/content/en/docs/updating/_index.md index 4b8269c37..6596efa26 100644 --- a/docsy.dev/content/en/docs/updating/_index.md +++ b/docsy.dev/content/en/docs/updating/_index.md @@ -5,11 +5,11 @@ weight: 8 --- We hope to continue to make improvements to the theme -[along with the Docsy community](/docs/contributing/). If you have -cloned the example site (or are otherwise using the theme as a Hugo Module or -Git submodule), you can easily update the Docsy theme in your site yourself. If -you have cloned the theme itself into your own project you can also update, -though you may need to resolve merge conflicts. +[along with the Docsy community](/docs/contributing/). If you have cloned the +example site (or are otherwise using the theme as a Hugo Module or Git +submodule), you can easily update the Docsy theme in your site yourself. If you +have cloned the theme itself into your own project you can also update, though +you may need to resolve merge conflicts. Updating Docsy means that your site will build using the latest version of Docsy at `HEAD` and include all the new commits or changes that have been merged since diff --git a/docsy.dev/content/en/docs/updating/updating-hugo-module.md b/docsy.dev/content/en/docs/updating/updating-hugo-module.md index 9f22dec1f..b85ab0909 100644 --- a/docsy.dev/content/en/docs/updating/updating-hugo-module.md +++ b/docsy.dev/content/en/docs/updating/updating-hugo-module.md @@ -23,9 +23,9 @@ done! > [!TIP] > -> If you want to set your module to a certain version inside the Docsy theme repo, -> simply specify the name of the tag representing this version when updating your -> theme, for example: +> If you want to set your module to a certain version inside the Docsy theme +> repo, simply specify the name of the tag representing this version when +> updating your theme, for example: > > ```bash > hugo mod get -u github.com/google/docsy@v{{% param "version" %}} diff --git a/docsy.dev/content/en/docs/updating/updating-submodules.md b/docsy.dev/content/en/docs/updating/updating-submodules.md index 26ef31147..b5b3be278 100644 --- a/docsy.dev/content/en/docs/updating/updating-submodules.md +++ b/docsy.dev/content/en/docs/updating/updating-submodules.md @@ -1,61 +1,69 @@ --- -title: "Update Docsy without Hugo Modules" -linkTitle: "Update Docsy without Hugo Modules" +title: Update Docsy without Hugo Modules weight: 2 description: > Update the Docsy theme to the latest version using submodules or `git pull`. --- -If you aren't using Hugo Modules, depending on how you chose to install Docsy on your existing site, use one of the following two procedures to update your theme. +If you aren't using Hugo Modules, depending on how you chose to install Docsy on +your existing site, use one of the following two procedures to update your +theme. > [!TIP] > > If you intend to update your site, consider > [converting your site to Hugo Modules](/docs/updating/convert-site-to-module/). ->After conversion, it's even simpler to update Docsy! +> After conversion, it's even simpler to update Docsy! ## Update your Docsy submodule -If you are using the [Docsy theme as a submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule) in your project, here's how you update the submodule: +If you are using the +[Docsy theme as a submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule) +in your project, here's how you update the submodule: 1. Navigate to the root of your local project, then run: - ```bash - git submodule update --remote - ``` + ```bash + git submodule update --remote + ``` 1. Add and then commit the change to your project: - ```bash - git add themes/ - git commit -m "Updating theme submodule" - ``` + ```bash + git add themes/ + git commit -m "Updating theme submodule" + ``` 1. Push the commit to your project repo. For example, run: - ```bash - git push origin master - ``` + ```bash + git push origin master + ``` ## Route 2: Update your Docsy clone -If you [cloned the Docsy theme](/docs/get-started/other-options/#option-2-clone-the-docsy-theme) into -the `themes` folder in your project, then you use the `git pull` command: +If you +[cloned the Docsy theme](/docs/get-started/other-options/#option-2-clone-the-docsy-theme) +into the `themes` folder in your project, then you use the `git pull` command: 1. Navigate to the `themes` directory in your local project: - ```bash - cd themes + ```bash + cd themes + + ``` 1. Ensure that `origin` is set to `https://github.com/google/docsy.git`: - ```bash - git remote -v + ```bash + git remote -v + ``` 1. Update your local clone: - ```bash - git pull origin master - ``` + ```bash + git pull origin master + ``` -If you have made any local changes to the cloned theme, **you must manually resolve any merge conflicts**. +If you have made any local changes to the cloned theme, **you must manually +resolve any merge conflicts**. diff --git a/docsy.dev/content/en/search.md b/docsy.dev/content/en/search.md index 57332e1fd..701743a6d 100644 --- a/docsy.dev/content/en/search.md +++ b/docsy.dev/content/en/search.md @@ -3,4 +3,3 @@ title: Search Results layout: search outputs: [HTML] --- - diff --git a/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md b/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md index f71cbeae0..7bb200f1c 100644 --- a/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md +++ b/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md @@ -18,7 +18,7 @@ description: A Hugo theme for creating great technical documentation sites
+ href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'> Get started
+ href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'> Get started
+ href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'> Get started
+ href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'> Get started @@ -96,28 +97,28 @@ on creating great content for your users.

See Docsy in action!

-

As well as our example site, there’s a growing number of projects using Docsy for their doc sites.

+

As well as our example site, there’s a growing number of projects using Docsy +for their doc sites.

Read more

-

Contributions welcome!

-

We do a Pull Request contributions workflow on GitHub. New users are always welcome!

+

We do a Pull Request contributions +workflow on GitHub. New users are always welcome!

Read more

-
From ce80e0a3489d34a237cc0e41ed25b507546e52eb Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 30 Apr 2026 07:29:22 -0400 Subject: [PATCH 2/2] Release report updates --- tasks/0.15/release-prep/commit-inventory.md | 26 ++++++++++++++++----- tasks/0.15/release-prep/index.plan.md | 8 +++---- tasks/0.15/release-prep/issue-audit.md | 19 ++++++++------- tasks/0.15/release-prep/wrapup-report.md | 16 ++++++++----- 4 files changed, 45 insertions(+), 24 deletions(-) diff --git a/tasks/0.15/release-prep/commit-inventory.md b/tasks/0.15/release-prep/commit-inventory.md index 2ca63575b..1af2d97ff 100644 --- a/tasks/0.15/release-prep/commit-inventory.md +++ b/tasks/0.15/release-prep/commit-inventory.md @@ -1,17 +1,17 @@ --- title: 0.15 commit inventory date: 2026-04-25 -lastmod: 2026-04-30 +lastmod: 2026-05-01 range: v0.14.3..main -last-main-commit: 7a0b370f +last-main-commit: 466bd327 --- ## Scope -Inventory covers commits in [v0.14.3...main][] through [7a0b370f][]. +Inventory covers commits in [v0.14.3...main][] through [466bd327][]. -- First-parent commits: 39 -- Raw commits in range: 48 +- First-parent commits: 43 +- Raw commits in range: 52 - Baseline: latest official release tag, [v0.14.3][] The extra raw commits are implementation commits that are also represented by @@ -81,6 +81,13 @@ uses first-parent commits as the release-audit spine. release-prep refresh, CI docs, and `readfile` shortcode cleanup - `7a0b370f` [#2616][] Update the 0.15 release blog, changelog, and user-guide docs; finalize 0.15 upgrade guidance around Hugo 0.157.0 and Node LTS 24 +- `9319aa47` [#2618][] Prepare 0.15.0 release tooling, site metadata, and + release-prep docs +- `f5ebf609` [#2619][] Add release-prep audit guidance; document missed 0.15.0 + user-visible changes +- `a19b3dd6` [#2620][] Replace `cd:docsy.dev` npm scripts with + `npm run -C docsy.dev` +- `466bd327` [#2621][] Prettierignore rule cleanup, and fix format of more pages ## Internationalization @@ -126,6 +133,9 @@ uses first-parent commits as the release-audit spine. rather than a separate user-facing feature. - [#2616][] finalizes the release blog, changelog, doc-rooted guidance, and version-support wording. It closes stale WIP notes from earlier report passes. +- [#2618][], [#2619][], [#2620][], and [#2621][] continue release prep: + tooling/metadata, audit guidance, npm `-C docsy.dev` ergonomics, and Prettier + ignore/format hygiene (see commits above). [#2082]: https://github.com/google/docsy/pull/2082 [#2555]: https://github.com/google/docsy/pull/2555 @@ -168,6 +178,10 @@ uses first-parent commits as the release-audit spine. [#2610]: https://github.com/google/docsy/pull/2610 [#2611]: https://github.com/google/docsy/pull/2611 [#2616]: https://github.com/google/docsy/pull/2616 -[7a0b370f]: https://github.com/google/docsy/commit/7a0b370f +[#2618]: https://github.com/google/docsy/pull/2618 +[#2619]: https://github.com/google/docsy/pull/2619 +[#2620]: https://github.com/google/docsy/pull/2620 +[#2621]: https://github.com/google/docsy/pull/2621 +[466bd327]: https://github.com/google/docsy/commit/466bd327 [v0.14.3...main]: https://github.com/google/docsy/compare/v0.14.3...main [v0.14.3]: https://github.com/google/docsy/releases/tag/v0.14.3 diff --git a/tasks/0.15/release-prep/index.plan.md b/tasks/0.15/release-prep/index.plan.md index c35c525a6..e1eaec089 100644 --- a/tasks/0.15/release-prep/index.plan.md +++ b/tasks/0.15/release-prep/index.plan.md @@ -1,8 +1,8 @@ --- title: 0.15 Release wrapup plan date: 2026-04-25 -lastmod: 2026-04-30 -last-main-commit: 7a0b370f +lastmod: 2026-05-01 +last-main-commit: 466bd327 --- ## Agent guidance @@ -134,7 +134,7 @@ When new commits land on `main`, repeat the following: or changelog. Refresh reports for commits in [v0.14.3...main][] through the commit named as -`last-main-commit` in this file’s front matter (currently [7a0b370f][]). +`last-main-commit` in this file’s front matter (currently [466bd327][]). ### 0.15.0 blog post @@ -169,7 +169,7 @@ Refresh reports for commits in [v0.14.3...main][] through the commit named as ../../../docsy.dev/content/en/project/about/changelog/#v0.15.0 [v0.14.3...main]: https://github.com/google/docsy/compare/v0.14.3...main [0.15.0 blog post]: ../../../docsy.dev/content/en/blog/2026/0.15.0.md -[7a0b370f]: https://github.com/google/docsy/commit/7a0b370f +[466bd327]: https://github.com/google/docsy/commit/466bd327 [changelog style guide]: ../../../docsy.dev/content/en/project/about/changelog/#style-guide [Docsy style guide]: ../../../docsy.dev/content/en/project/style-guide/ diff --git a/tasks/0.15/release-prep/issue-audit.md b/tasks/0.15/release-prep/issue-audit.md index 116f0416a..92c551023 100644 --- a/tasks/0.15/release-prep/issue-audit.md +++ b/tasks/0.15/release-prep/issue-audit.md @@ -1,15 +1,15 @@ --- title: 0.15 issue audit date: 2026-04-25 -lastmod: 2026-04-30 +lastmod: 2026-05-01 range: v0.14.3..main -last-main-commit: 7a0b370f +last-main-commit: 466bd327 cSpell:ignore: afdocs overpromising --- ## Scope -Draft audit covers material changes in [v0.14.3...main][] through [7a0b370f][]. +Draft audit covers material changes in [v0.14.3...main][] through [466bd327][]. This is an evidence pass for review before writing the wrapup report, release blog post, or changelog updates. @@ -30,10 +30,9 @@ blog post, or changelog updates. content rendering. - [#2585][] raises the repository-supported Hugo version to 0.157.0 and keeps release guidance on Node LTS 24. -- Changelog status: refreshed 0.15.0 entry exists ([#2616][]); final release - pass still needs replacing prerelease/release-page placeholders when tagging. -- Blog status: refreshed release report exists at - `docsy.dev/content/en/blog/2026/0.15.0.md` ([#2616][]). +- Changelog / blog: refreshed for **0.15** through [#2616][] and follow-on prep + ([#2618][], [#2619][], [#2620][], [#2621][]). Final tagging pass still + replaces prerelease/release-page placeholders as needed. - Link check: the agent-support user-guide page is now on `main` via [#2611][]; the earlier blog-link blocker is resolved. @@ -368,6 +367,10 @@ Raw commits in scope without PR numbers in their commit subjects: [#2611]: https://github.com/google/docsy/pull/2611 [#2614]: https://github.com/google/docsy/issues/2614 [#2616]: https://github.com/google/docsy/pull/2616 +[#2618]: https://github.com/google/docsy/pull/2618 +[#2619]: https://github.com/google/docsy/pull/2619 +[#2620]: https://github.com/google/docsy/pull/2620 +[#2621]: https://github.com/google/docsy/pull/2621 [#726]: https://github.com/google/docsy/issues/726 -[7a0b370f]: https://github.com/google/docsy/commit/7a0b370f +[466bd327]: https://github.com/google/docsy/commit/466bd327 [v0.14.3...main]: https://github.com/google/docsy/compare/v0.14.3...main diff --git a/tasks/0.15/release-prep/wrapup-report.md b/tasks/0.15/release-prep/wrapup-report.md index 5f91b4a9e..c40face69 100644 --- a/tasks/0.15/release-prep/wrapup-report.md +++ b/tasks/0.15/release-prep/wrapup-report.md @@ -1,13 +1,13 @@ --- title: 0.15 release-prep wrapup report date: 2026-04-25 -lastmod: 2026-04-30 +lastmod: 2026-05-01 range: v0.14.3..main -last-main-commit: 7a0b370f +last-main-commit: 466bd327 cSpell:ignore: afdocs --- -> Report prepared for commits in [v0.14.3...main][] through [7a0b370f][]. +> Report prepared for commits in [v0.14.3...main][] through [466bd327][]. ## Release Themes @@ -48,7 +48,8 @@ cSpell:ignore: afdocs - Added the Agent support user-guide page and refreshed the release prep reports ([#2611][]). - Updated changelog "Next release" section with 0.15 highlights and links; the - latest release-content pass is [#2616][]. + primary release-content pass is [#2616][], followed by prep/tooling PRs + ([#2618][], [#2619][], [#2620][], [#2621][]). - Omit 0.14.3-only fixes from 0.15 highlights. The 0.14 release resources already cover the v0.14.3 layout fix. - The earlier Agent support blog-link blocker is resolved: [Agent support][] is @@ -67,7 +68,6 @@ cSpell:ignore: afdocs - [x] Review the 0.15 release report for user-guide links and action guidance. - [x] Review the changelog entry after the blog draft is final so it stays terse and points to the release report for detail. -- [ ] Decide whether a docsy-example follow-up PR is needed. ## References @@ -86,6 +86,10 @@ cSpell:ignore: afdocs [#2611]: https://github.com/google/docsy/pull/2611 [#2614]: https://github.com/google/docsy/issues/2614 [#2616]: https://github.com/google/docsy/pull/2616 -[7a0b370f]: https://github.com/google/docsy/commit/7a0b370f +[#2618]: https://github.com/google/docsy/pull/2618 +[#2619]: https://github.com/google/docsy/pull/2619 +[#2620]: https://github.com/google/docsy/pull/2620 +[#2621]: https://github.com/google/docsy/pull/2621 +[466bd327]: https://github.com/google/docsy/commit/466bd327 [Agent support]: ../../../docsy.dev/content/en/docs/content/agent-support/ [v0.14.3...main]: https://github.com/google/docsy/compare/v0.14.3...main