Skip to content

Add language identifiers to the code blocks in three reference solutions #268

Closed

Description

@accesswatch

What is wrong

Three reference solutions open fenced code blocks with no language identifier (a bare three-backtick line):

  • docs/solutions/solution-04-branch-out.md (2 blocks)
  • docs/solutions/solution-05-make-your-mark.md (3 blocks)
  • docs/solutions/solution-07-merge-conflict.md (3 blocks)

Without a language, the site cannot highlight the block, and a reader cannot tell from the source whether a block is a command to type, output to expect or a file's contents. Naming it (bash, text, markdown) makes that explicit.

Why this is a good first issue

It is eight small edits in three files, and each one asks a single question: what is in this block?

What to do

  1. Open each file and find the opening fence of each block the check reports: node scripts/check-docs-accessibility.js --report docs/solutions/solution-04-branch-out.md docs/solutions/solution-05-make-your-mark.md docs/solutions/solution-07-merge-conflict.md.
  2. Add a language after the opening backticks: bash for commands, text for output or plain text, markdown for Markdown, diff for a diff. Change nothing inside the block.
  3. Lower the counts for these files in scripts/docs-accessibility-baseline.json (delete the code-fence-language entry when it reaches zero).
  4. Run npm run build:html and commit the Markdown and the regenerated html/ together.

Acceptance criteria

  • The report command above lists no code-fence-language findings for the three files.
  • npm run check:accessibility passes.

The same finding appears in about 30 other files; they are listed in #267 and can be picked up the same way, a few files per pull request.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    accessibilityAccessibility barriers, reports and improvementsdocumentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions