Style cleanup: add missing keywords and remove bold-for-emphasis#25127
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
LGTM |
|
/review |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
Well-scoped style cleanup across 100+ guide pages. The keywords: frontmatter additions are accurate and well-formed throughout. Bold-for-emphasis removals are correct, and several bonus fixes (sentence-case headings, click→select, hedge word removal, blockquote→callout conversion) are all improvements. Three minor observations in inline comments.
|
|
||
| 1. Go to the Actions tab in your GitHub repository. | ||
| 2. Click into the workflow run to follow each step: **build**, **test**, and (if successful) **push**. | ||
| 2. Select the workflow run to follow each step: `build`, `test`, and (if successful) `push`. |
There was a problem hiding this comment.
[LOW] Parentheses retained after removing bold
This line correctly changes Click to Select and removes bold from step names — good fixes. However, the parenthetical (if successful) remains. Per STYLE.md, parentheses should be avoided in technical documentation as they reduce readability. Consider rewriting to: Select the workflow run to follow each step: \build`, `test`, and, if successful, `push`.`
| settings: | ||
| - **Client ID**: `product-service` | ||
| - **Client Authentication**: **On** | ||
| - **Client Authentication**: `On` |
There was a problem hiding this comment.
[LOW] UI toggle value converted from bold to inline code
**Client Authentication** (bold) is correct as a UI field label. For the value On, bold (**On**) was arguably also appropriate since it is a UI toggle state displayed in the interface — STYLE.md reserves bold for UI elements including field labels. Inline code (`On`) suggests a command or literal string rather than a UI value. Consider keeping it bold: **Client Authentication**: **On**, or checking what the UI actually shows for consistency.
|
|
||
| ## Internal network access (container-to-container) | ||
|
|
||
| When your application runs in another container, connecting to PostgreSQL through a user-defined bridge network is the recommended approach. This setup provides automatic DNS resolution, so your application can connect to PostgreSQL using the container name as the hostname, without needing to track IP addresses. |
There was a problem hiding this comment.
[LOW] Plain "Term: description" list pattern remains after bold removal
Removing bold from these list items (**Prerequisite**: → Prerequisite:, **Key point**: → Key point:, **PostgreSQL URI format**: → PostgreSQL URI format:, etc.) is the right call per STYLE.md. However, STYLE.md also discourages the Term: description label pattern entirely — even without bold — recommending simple descriptive bullets or prose instead. Since these are pre-existing structural patterns, this is low priority and fine to leave for a follow-up pass.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This is a well-scoped, mechanical style-conformance PR. The two changes (adding missing keywords: front matter and removing bold-for-emphasis) are correctly applied throughout:
Keywords additions: All 104 added keywords: entries are meaningful, page-specific, and properly formatted as comma-separated lowercase terms. The required front matter field is now present on all affected guide pages.
Bold-for-emphasis removal: De-bolded ~60 **Term**: description list items, converted identifiers/values to inline code (e.g. my-mysql, 3307:3306), removed product/emphasis bolds, and converted blockquote-style notes to proper > [!NOTE] callouts — all in line with STYLE.md requirements. Legitimate UI bolds (buttons, menus, column labels like Port(s), Containers view) were preserved correctly.
Heading case fixes: Sentence-case heading corrections (e.g. "Project Structure" → "Project structure") are consistent with STYLE.md.
No hedge words, scope inflation, broken markdown, missing redirects, or vendored file changes were found in the added lines.
5 participants
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.