Skip to content
This repository is currently being migrated. It's locked while the migration is in progress.

Results description: Remove bold from Code guidance bullets#6168

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/update-code-guidance-unbold
Draft

Results description: Remove bold from Code guidance bullets#6168
Copilot wants to merge 2 commits into
mainfrom
copilot/update-code-guidance-unbold

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 22, 2026

All seven bullet points in the #### Code guidance subsection of src/_includes/components/results-description.md were wrapped in **...**. This removes that bold styling while preserving all wording, structure, and inline code formatting.

Changes

  • src/_includes/components/results-description.md — Stripped **...** from every bullet in the Code guidance section; no other content altered
Original prompt

Update PR #6167 in department-of-veterans-affairs/vets-design-system-documentation by editing the "Code guidance" section of the "Results description" content so that all text in that Code guidance section is not bold.

Requirements:

  • Identify the file(s) changed in PR Search results: Update Results description with Structure and Code guidance #6167 that contain the "Results description" and its "Code guidance" section.
  • In the "Code guidance" section, remove markdown bold formatting (e.g., **...** or equivalent) from all text.
  • Preserve wording and structure; only remove bold styling.
  • Ensure any code blocks, links, headings, and other formatting remain intact.
  • Run/ensure any linting or formatting checks used by the repo (as feasible in CI) pass.

Context:

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: unbold everything in Code guidance section of Results description

Assistant: I’m standing by for your confirmation/approval in the dialog so I can proceed to remove all bold formatting from the “Code guidance” section in the “Results description” content of PR #6167.

This pull request was created from Copilot chat.

Copilot AI requested review from Copilot and removed request for Copilot April 22, 2026 23:21
Copilot AI requested review from Copilot and removed request for Copilot April 22, 2026 23:23
Copilot AI changed the title [WIP] Update Code guidance section to remove bold formatting Results description: Remove bold from Code guidance bullets Apr 22, 2026
Copilot AI requested a review from derekwang99 April 22, 2026 23:24
@derekwang99 derekwang99 marked this pull request as ready for review April 22, 2026 23:25
@derekwang99 derekwang99 requested a review from a team as a code owner April 22, 2026 23:25
Copilot AI review requested due to automatic review settings April 22, 2026 23:25
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the “Results description” include used by the Search results template (and Pagination component) docs, with the stated goal of removing bold styling from the “Code guidance” bullets.

Changes:

  • Removes bold formatting from the “Code guidance” bullet text.
  • Restructures the include by adding a “Structure” subsection and rewriting/removing some previously existing guidance/examples.


* **Update when filters change.** The results description must update when filters are changed so that all users can understand that the results have been updated. Implementation should follow this format:
* Showing 1–10 of 999 for "[query]"
* When used in non-search contexts, omit the `for "[query]"` portion.
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

This update removes the explicit requirement that the results description update when filters change (and previously included an example like “with X filters applied”). Since this include is used by the Search results template page (which doesn’t restate that requirement elsewhere), this guidance likely needs to remain here to avoid losing an important accessibility/UX constraint.

Suggested change
* When used in non-search contexts, omit the `for "[query]"` portion.
* When used in non-search contexts, omit the `for "[query]"` portion.
* The results description should update when filters change so it reflects the currently shown result set.

Copilot uses AI. Check for mistakes.
The implementation should follow this format:

* **Update when filters change.** The results description must update when filters are changed so that all users can understand that the results have been updated. Implementation should follow this format:
* Showing 1–10 of 999 for "[query]"
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

The example format now says “Showing 1–10 of 999 for "[query]"”, but the intro sentence describes “how many results are being shown” and the prior content used “999 results”. Consider adding “results” back into the example (or adjusting the intro) to keep terminology consistent and avoid ambiguity.

Suggested change
* Showing 1–10 of 999 for "[query]"
* Showing 1–10 of 999 results for "[query]"

Copilot uses AI. Check for mistakes.
Comment on lines 1 to 12
Text describing how many results are being shown.

* **Showing 1–10 of 999 results for "[query]".** The implementation should follow this format:
#### Structure

> Showing 1–10 of 999 results for "[query]"
* When used in non-search contexts, omit the `for "[query]"` portion. For example: `Showing 1–10 of 999 results.`
The implementation should follow this format:

* **Update when filters change.** The results description must update when filters are changed so that all users can understand that the results have been updated. Implementation should follow this format:
* Showing 1–10 of 999 for "[query]"
* When used in non-search contexts, omit the `for "[query]"` portion.
* If a filter is applied to the results, add "with X filters applied" to the end. This is not necessary when sorting is applied since the Sort component itself acts as the visual indicator.

> Showing 1–10 of 999 results for "[query]" with 5 filters applied.
#### Code guidance

Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

The PR description/title say this change only removes bold styling from the existing Code guidance bullets, but this diff also restructures the section (adds a new “Structure” heading) and removes/replaces previously existing guidance and examples. Either update the PR description to match the actual content changes, or revert the non-bolding edits so the change set aligns with the stated intent.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants