Style cleanup: add missing keywords and remove bold-for-emphasis#25127
Open
brandonh6k wants to merge 7 commits into
Open
Style cleanup: add missing keywords and remove bold-for-emphasis#25127brandonh6k wants to merge 7 commits into
brandonh6k wants to merge 7 commits into
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Two related style-conformance fixes across
content/guides/, motivated by a recent audit of guide-page style against STYLE.md, COMPONENTS.md, and AGENTS.md.What changed
1. Add missing
keywords:frontmatter to 104 guide pageskeywordsis documented as required (AGENTS.md, COMPONENTS.md) but was missing from 10 single-file guides, 8_index.mdlanding pages, and 86 chapter pages. Each page now has a meaningful, page-specific comma-separated keyword list derived from its title, lead content, and sibling pages where applicable.Examples of the convention applied:
content/guides/testcontainers-java-spring-boot-kafka/create-project.md—testcontainers, java, spring boot, kafka, mysql, project setupcontent/guides/docker-compose/why.md—docker compose, multi-container, yaml, services, orchestration, applicationPost-change verification confirms zero guide pages under
content/guides/are missing the field.2. Remove bold-for-emphasis from 14 guide pages
STYLE.md restricts bold to UI elements only — never for emphasis, product names, command names, or the
**Term**: descriptionsubsection-label pattern. Cleaned up the top-15 offender files identified by raw bold-span count (code blocks excluded). One file (jupyter.md, 32 spans) was untouched because all spans were legitimate UI references.Shape of the work across 14 files:
**Term**: descriptionlist items de-bolded**my-mysql**→`my-mysql`)> [!NOTE]calloutsLegitimate UI bolds (button names, menu items, field labels, tab names) were preserved throughout.
databases.mdkept 47 of 49 spans for this reason — only port-mapping value and container name were converted to backticks.Out of scope
The audit surfaced other items not addressed here:
paramsblock missing on all 48_index.mdlanding pages — this is a "decide what's authoritative" question that warrants discussion before code changes.just,easily,we, etc.) — concentrated in ~5 files; can land separately.## Step N:vs## N.vs plain) — undocumented; should be pinned down in STYLE.md or COMPONENTS.md before mechanical sweeps.Verification
markdownlint(viascripts/lint.sh) clean on all changed files.git diff --statconfirms scope: 118 unique files, all undercontent/guides/. No vendored, layout, or generated-file changes.