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

Frontmatter style guide fixes #17394

Merged
merged 9 commits into from
May 22, 2024
Merged

Conversation

austin-schaefer
Copy link
Collaborator

@austin-schaefer austin-schaefer commented May 21, 2024

  • Clarifies what all the docs site frontmatter fields do
  • Corrects a bunch of inaccuracy about old content types
  • Adds definitions for new content types that weren't accurate
  • Sweeps docs to remove a bunch of unused frontmatter fields to avoid future confusion

Reviewer: Please focus on the "Frontmatter and page templates" doc, the rest of this is just sweep work. I want to ensure the changed doc is helpful and accurate for writers

@austin-schaefer austin-schaefer added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels May 21, 2024
@austin-schaefer austin-schaefer changed the title Frontmatter edit improvements Frontmatter style guide fixes May 21, 2024
@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues May 21, 2024
@github-actions github-actions bot requested a review from nbaenam May 21, 2024 21:52
Copy link

Hi @austin-schaefer 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented May 21, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 0eae584
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/664db9618899fd0007c65c37
😎 Deploy Preview https://deploy-preview-17394--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

src/nav/style-guide.yml Outdated Show resolved Hide resolved
akristen
akristen previously approved these changes May 21, 2024
Copy link
Contributor

@akristen akristen left a comment

Choose a reason for hiding this comment

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

This looks good to me! I reviewed the frontmatter doc and it built fine, tables rendered correctly, and the copy is good. Some nitpicky things, but overall i think it's good to merge as is :)

Copy link
Contributor

@nbaenam nbaenam left a comment

Choose a reason for hiding this comment

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

I fixed a typo. Other than that it's perfect!

@ally-sassman ally-sassman moved this from Hero to triage to In progress in Docs PRs and Issues May 22, 2024
@austin-schaefer austin-schaefer merged commit 7c556b0 into develop May 22, 2024
19 checks passed
@austin-schaefer austin-schaefer deleted the frontmatter-edit-improvements branch May 22, 2024 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants