Skip to content

Refactor content style guide updates page#1722

Merged
Chris Pymm (chrispymm) merged 4 commits intomainfrom
simplify-content-style-guide-updates-page
Sep 16, 2025
Merged

Refactor content style guide updates page#1722
Chris Pymm (chrispymm) merged 4 commits intomainfrom
simplify-content-style-guide-updates-page

Conversation

@chrispymm
Copy link
Contributor

The style guide updates page required authoring in html - ading all content manually into a <table> and ensuring all govuk and sortable table classes were correct.

This was hard to do and error-prone, and turned what should be simple content additions into a complex dev-focused task.

This PR extracts all the markup into a layout file, and then makes each style guide update entry into its own .md file which are then collated into an eleventy collection to be output on the style guide updates page within the sortable table layout.

Adding an entry to the style guide is now a matter of creating a new file YYYY-MM-DD-Filename.md within the 'docs/style-guide-updates` directory with the format:

---
title: Entry title
anchor: the anchor link to the item in the style guide (the bit after the #)
type: updated | new
date: yyyy-mm-dd
---

Update content in markdown format

@chrispymm Chris Pymm (chrispymm) requested a review from a team as a code owner September 2, 2025 06:05
@chrispymm Chris Pymm (chrispymm) added the preview:request Deploy PR to a preview url label Sep 2, 2025
@chrispymm Chris Pymm (chrispymm) force-pushed the simplify-content-style-guide-updates-page branch from c221ba5 to ff2a731 Compare September 2, 2025 06:15
@github-actions
Copy link

github-actions bot commented Sep 2, 2025

🚀 Deployed to preview environment! If this is the first deploy, you may have to wait a few minutes for your preview site to be ready on the following URL:

https://moj-frontend-pr-1722.apps.live.cloud-platform.service.justice.gov.uk

Username: preview, Password: moj

@github-actions github-actions bot added preview:active and removed preview:request Deploy PR to a preview url labels Sep 2, 2025
@chrispymm Chris Pymm (chrispymm) force-pushed the simplify-content-style-guide-updates-page branch from ff2a731 to 048b36c Compare September 2, 2025 08:30
@github-actions
Copy link

github-actions bot commented Sep 2, 2025

🚀 Deployed to preview environment! If this is the first deploy, you may have to wait a few minutes for your preview site to be ready on the following URL:

https://moj-frontend-pr-1722.apps.live.cloud-platform.service.justice.gov.uk

Username: preview, Password: moj

@chrispymm Chris Pymm (chrispymm) linked an issue Sep 2, 2025 that may be closed by this pull request
@chrispymm Chris Pymm (chrispymm) force-pushed the simplify-content-style-guide-updates-page branch from 048b36c to 2ed548a Compare September 5, 2025 05:27
@github-actions
Copy link

github-actions bot commented Sep 5, 2025

🚀 Deployed to preview environment! If this is the first deploy, you may have to wait a few minutes for your preview site to be ready on the following URL:

https://moj-frontend-pr-1722.apps.live.cloud-platform.service.justice.gov.uk

Username: preview, Password: moj

@chrispymm Chris Pymm (chrispymm) merged commit f04bbbf into main Sep 16, 2025
15 checks passed
@chrispymm Chris Pymm (chrispymm) deleted the simplify-content-style-guide-updates-page branch September 16, 2025 10:47
@chrispymm
Copy link
Contributor Author

🎉 This PR is included in version 5.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve code on content style guide updates page

2 participants