Skip to content

docs: add cross-platform docs checklist - #12

Open
slegarraga wants to merge 1 commit into
rback37:mainfrom
slegarraga:docs/cross-platform-docs-checklist
Open

docs: add cross-platform docs checklist#12
slegarraga wants to merge 1 commit into
rback37:mainfrom
slegarraga:docs/cross-platform-docs-checklist

Conversation

@slegarraga

Copy link
Copy Markdown

Closes #9

What

  • Adds a ten-minute, Git-only workflow for first-time documentation contributors.
  • Covers cloning/updating, optional Markdown preview, relative link/image checks, one focused edit, privacy-safe diff review, and opening a pull request.
  • Includes Windows PowerShell, macOS, and Linux notes where behavior genuinely differs.
  • Explicitly states that main is the public product-and-community documentation home, not production source.
  • Links the checklist from CONTRIBUTING.md.

Verification

  • Followed the checklist against the current repository clone.
  • Verified every referenced local file exists.
  • Verified the documented relative link target resolves to ROADMAP.md.
  • Confirmed no Node.js/npm/build/test commands are introduced because no runnable source exists on main.
  • Checked that all examples are synthetic and the diff contains only documentation changes.

Give first-time contributors a Git-only path to clone, preview, edit, privacy-review, and open a focused documentation pull request on Windows, macOS, and Linux. Closes rback37#9.
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.

[Good first issue] Add a 10-minute Windows, macOS, and Linux documentation contribution checklist

1 participant