Use sentence case for titles, linktitles, and headings - #3742
Open
SharpRake wants to merge 2 commits into
Open
Conversation
Convert titles, linktitles, headings, and link text from title case to sentence case across the Get started, Products (Containers, Libraries, OS, Repository, VMs, Actions, Agent Skills, Guardener), Platform, Open source, Software security, and Compliance sections, per the Google developer documentation style guide. Product names, third-party tools, official standards and agencies, and the titles of external works (courses, talks, blog posts) keep their existing capitalization. Auto-generated docs under content/platform/chainctl/ and cloudevents/events-reference.md are untouched. Also repoints 21 pre-existing broken anchor links, including the Starter to Free tier rename. https://linear.app/chainguard/issue/DOCS-60/mass-updates-from-title-sentence-case-in-titles-and-linktitles Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
|
Love it @SharpRake ! |
The pre-commit CI job runs the whitespace hooks against every file a PR touches, so the sentence-case pass pulled 45 files with pre-existing violations into scope. Strip a whitespace-only line from two _index.md files and collapse the extra trailing newline in 43 others. Whitespace only; no content changes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[ ] Check if this is a typo or other quick fix and ignore the rest :)
Type of change
Documentation Update
What should this PR do?
resolves https://linear.app/chainguard/issue/DOCS-60/mass-updates-from-title-sentence-case-in-titles-and-linktitles
Standardizes titles, linktitles, and headings on sentence case across Get started, Products, Platform, Open source, Software security, and Compliance.
Why are we making this change?
Academy has historically mixed title and sentence case. The Google developer documentation style guide specifies sentence case, and consistency makes headings easier to scan and removes a recurring judgement call for authors.
What are the acceptance criteria?
content/platform/chainctl/andcloudevents/events-reference.mdHow should this PR be tested?
Any documentation published to Chainguard Academy is reviewed carefully for accuracy. GUI procedures, API commands, and CLI code snippets in a draft are run and tested thoroughly — by both the author and the reviewer — to confirm they work exactly as written. This helps ensure that readers can follow along and get the same results. See the
edurepo's README.config/_default/menus/menus.en.tomllayouts/index.html/chainguard/chainguard-images/about/images-categories/#free-containers🤖 Generated with Claude Code