Skip to content

Improve structure of content style guide page #1830

@chrispymm

Description

@chrispymm

What

Update the content style guide page to leverage the build system of eleventy.

Break out the page into one markdowm file per term, and then get eleventy to do the work of compiling those into one alphabetical list on a page.

Why

Editing content on this page can be a bit problematic, and requires the content designer to also navigate nunjucks html and markdown syntax all in one file.

It also requires edits to be added / updated in the correct place to maintain the correct ordering, and this file will continue to get larger and larger.

Making these updates would mean that content updates / additions would only require interacting with markdown, and each entry would be its own file.

Another advantage of this is that external contributors will be more able to submit their own updates and additions.

Who needs to be involved

  • Content Designer
  • Developer

Done

  • When the content style guide structure has been updated, but the page visually looks and behaves the same.
  • When the guide on updating the style guide has been updated

Metadata

Metadata

Labels

maintenanceA task that keeps the design system in tip-top shape

Type

Projects

Status

To Do

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions