Skip to content

docs: fix mojibake and normalize punctuation#4

Merged
iplaycomputer merged 1 commit intomainfrom
chore/fix-mojibake-markdown
Sep 29, 2025
Merged

docs: fix mojibake and normalize punctuation#4
iplaycomputer merged 1 commit intomainfrom
chore/fix-mojibake-markdown

Conversation

@iplaycomputer
Copy link
Copy Markdown
Owner

docs: fix mojibake and normalize punctuation

Summary

Clean up mojibake/encoding artifacts and normalize punctuation across Markdown.
Formatting-only; no steps, commands, links, or content changed.

Linked Artifacts (relative paths)

  • Ticket(s):
    • /tickets/account-locked-out.md
    • /tickets/outlook-disconnected-password-prompts.md
  • KB:
    • /kb/outlook-reconnect-after-update.md
  • Lab:
    • /labs/nginx-startup-fail.md
  • Scenario:
    • (none; only templates/README updated)

Also touched (non-artifact docs/templates):

  • /README.md
  • /000.scenario-template.md
  • /000.lab-template.md
  • /ROLES.md
  • /METRICS.md
  • /.github/PULL_REQUEST_TEMPLATE.md
  • /copilot-instructions.md

Checklists

  • Content

    • Uses the correct template (copied from 000.*-template.md)
    • Clear, reproducible steps and plain language
    • Relative links resolve inside the repo
    • Avoid duplication across modules (KB = productized steps; Lab = full commands + Verification; Scenario = flow/success, links only)
    • Deep link to sections where applicable (KB → #resolution-steps, Lab → #verification)
  • Metadata

    • Owner set; Last Reviewed and Next Review Due (KB/Lab)
    • Escalation Path filled (Ticket)
    • Metrics block added if useful (see docs/METRICS.md)
  • Quality

    • Verification steps included (expected outputs / pass-fail)
    • Anchors exist and resolve (KB “Resolution Steps”, Lab “Verification”)
    • Scenario (if present) ties Ticket → KB → Lab and defines success criteria

Labs (if included)

  • Dedicated “Verification” section with expected outputs
  • Images pinned if using containers; HTTP services include a simple healthcheck when applicable
  • Assets stored under labs/<lab>/assets/

KBs (if included)

  • Brief (1–2 lines) verification; link to related Lab for full commands

Scenarios (if included)

  • Uses deep links to KB “Resolution Steps” and Lab “Verification” (no step duplication)

Notes

  • Replaced mis-decoded characters with proper UTF-8: en dash (–), em dash (—), right arrow (→), smart quotes (“ ” ‘ ’), middle dot (•).
  • Updated tickets, scenarios, labs, KB, docs, and .github templates.
  • Nginx lab: fixed list indentation/numbering (MD007/MD029/MD032) without altering meaning.
  • Repo-wide search shows no mojibake patterns remaining.
  • markdownlint passes on edited files; README remains ignored by lint and emojis render correctly.
  • Very low risk. Formatting only; no behavioral or procedural changes.

How to Verify (for reviewers)

  • Click Related KB/Lab links and confirm they jump to the correct anchors.
  • If a Lab changed, run the Verification steps and confirm expected outputs.
  • Confirm that mojibake artifacts are gone and markdownlint passes.
  • Check that no personal IPs or credentials are included; <vm-ip> placeholders remain.

Follow-ups (optional, separate PR)

  • Add .gitattributes to normalize line endings and enforce UTF-8.
  • Tiny lint script and/or CI check to catch future encoding drift.

Closes: n/a

- Replace mis-decoded characters (â, ) with proper UTF-8 (– — → “ ” ‘ ’ •)
- tickets: titles and bullets
- scenarios: arrows/quotes
- labs: quotes, en dashes, bullet symbol; fix list structure/indentation
- kb/docs/.github templates: arrows/quotes/em-dash fixes

No content changes; formatting only. Lint remains clean.
@iplaycomputer iplaycomputer self-assigned this Sep 29, 2025
@iplaycomputer
Copy link
Copy Markdown
Owner Author

Reviewer tips (Expanded)

  • For the Nginx lab, expand the Steps and Verification sections and confirm list formatting renders correctly on GitHub (ordered numbers and code blocks).
  • Skim .github templates in the PR diff to confirm smart quotes/arrows are rendering as intended.
  • Search the diff for any remaining â or  to be safe (should be none).

@iplaycomputer iplaycomputer merged commit 99a5bfb into main Sep 29, 2025
1 check passed
@iplaycomputer iplaycomputer deleted the chore/fix-mojibake-markdown branch September 29, 2025 16:32
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.

1 participant