Skip to content

docs: fix markdown lint issues and typos in README - #480

Open
alwynpan wants to merge 1 commit into
nfrastack:mainfrom
alwynpan:docs/readme-markdown-lint
Open

docs: fix markdown lint issues and typos in README#480
alwynpan wants to merge 1 commit into
nfrastack:mainfrom
alwynpan:docs/readme-markdown-lint

Conversation

@alwynpan

@alwynpan alwynpan commented May 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Cleans up the README's markdown and fixes documentation typos.

Markdown lint

  • Blank lines around headings/tables, consistent emphasis style, removed multiple blank lines.
  • Converted indented code blocks to fenced blocks and added languages (text/bash/json).
  • Fixed a broken in-doc link (#data-volumes#persistent-storage) and two MSSQL tables missing a trailing _FILE cell.
  • Re-aligned affected table rows so pipes stay consistent.

Typos

  • seperating/Seperateseparating/Separate
  • BACKUP_LOCTIONBACKUP_LOCATION
  • executed.Seeexecuted. See, targedtarget, the a cleanupa cleanup
  • doubled "files files", stray :., unclosed parens, #4=$4=, syntax/syntax:, and a malformed backtick.

@tiredofit
tiredofit force-pushed the main branch 2 times, most recently from 51cee5f to c2fccc6 Compare August 24, 2026 16:50
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