Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style guide: full stop in frontmatter descriptions #6033

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

gvasquezvargas
Copy link
Contributor

What Changed?

Since page descriptions are being used to dynamically add summary tiles to index pages, we should probably make frontmatter descriptions obligatory. I think we should then also make full stops for descriptions a style guide requirement, so that tiles look consistent when displayed next to other pages' descriptions.

See screenshot for example:

E.g.
Screenshot 2024-09-09 at 14 37 10

WDYT?

@gvasquezvargas gvasquezvargas added the deploy Add this label to a PR and it will automatically be deployed to netlify label Sep 9, 2024
@gvasquezvargas gvasquezvargas requested a review from a team as a code owner September 9, 2024 13:10
Copy link
Contributor

github-actions bot commented Sep 9, 2024

@github-actions github-actions bot temporarily deployed to pr-6033-docs-style_guide September 9, 2024 13:19 Inactive
@github-actions github-actions bot temporarily deployed to pr-6033-docs-style_guide September 9, 2024 20:30 Inactive
Copy link
Contributor

@djw-m djw-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@github-actions github-actions bot temporarily deployed to pr-6033-docs-style_guide September 24, 2024 07:35 Inactive
Copy link
Contributor

@ebgitelman ebgitelman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edits.

@gvasquezvargas gvasquezvargas merged commit 5e64931 into develop Sep 25, 2024
3 checks passed
@gvasquezvargas gvasquezvargas deleted the docs/style_guide branch September 25, 2024 07:47
@djw-m djw-m mentioned this pull request Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Add this label to a PR and it will automatically be deployed to netlify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants