Style guide best practices #23516
Style guide best practices #23516
Conversation
|
Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment. We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally. PR Change SummaryEnhanced the style guide by introducing a new section on documentation practices and updating existing content for clarity and consistency.
Modified Files
Added Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add |
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
kodster28
requested review from
GregBrimble,
KianNH,
WalshyDev and
pedrosousa
as code owners
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
caley-b
left a comment
caley-b
left a comment
There was a problem hiding this comment.
Made some subjective suggestions and called out areas for slight expansions or customer experience examples to really highlight the pain of something (e.g., redirect chain, etc.). Super stoked to see this section become a thing!!
...content/docs/style-guide/documentation-content-strategy/component-attributes/screenshots.mdx
Outdated
Show resolved
Hide resolved
...content/docs/style-guide/documentation-content-strategy/component-attributes/screenshots.mdx
Show resolved
Hide resolved
...content/docs/style-guide/documentation-content-strategy/component-attributes/screenshots.mdx
Show resolved
Hide resolved
Co-authored-by: Caley Burton <[email protected]>
|
This PR requires additional review attention because it affects the following areas: RedirectsThis PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
* structure * Image maintenance * Add page on screenshots * Finish screenshot guidelines * migrated over info on redirects * structure for metadata page * Add in code examples for metadata * Added scripts and links to redirects * Finish adding in links * Denise feedback * Apply suggestions from code review Co-authored-by: Caley Burton <[email protected]> * Tweaks from Caley * Small update --------- Co-authored-by: Caley Burton <[email protected]>
* structure * Image maintenance * Add page on screenshots * Finish screenshot guidelines * migrated over info on redirects * structure for metadata page * Add in code examples for metadata * Added scripts and links to redirects * Finish adding in links * Denise feedback * Apply suggestions from code review Co-authored-by: Caley Burton <[email protected]> * Tweaks from Caley * Small update --------- Co-authored-by: Caley Burton <[email protected]>
3 participants
Summary
Adds a new
how we docssection to the style guide, where we're sharing out the why and how we approach specific problems within tech writing.