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

[rback37]

Debt World’s current main branch is the public product-and-community documentation home. It does not yet contain a runnable application package, so this checklist must document the workflow that exists today rather than inventing Node.js or npm steps.

Small scope

• Document how to clone and update the repository with Git.
• Show how to preview the Markdown files and check relative links and images.
• Show how to create a branch and make one small documentation or glossary edit.
• Explain how to inspect the diff for credentials, personal financial information, private conversations, and unintended generated files.
• End with the steps for opening one focused pull request.
• Add Windows PowerShell, macOS, and Linux notes only where the commands or behavior genuinely differ.

Requirements

• Git is the only required tool.
• An editor or browser-based Markdown preview may be optional.
• Do not add Node.js, npm, build, lint, or test commands unless runnable source has landed on main.
• Do not imply that the documentation repository is already the production source tree.

Done when

A first-time contributor on Windows, macOS, or Linux can clone the current repository, preview its documentation, make one privacy-safe change, review the diff, and open a focused pull request in about ten minutes.

Privacy boundary

Use synthetic examples only. Never add a real password, token, environment value, bank detail, identity document, exact personal debt or income, private AI conversation, or screenshot containing personal browser or account information.

[slegarraga]

Happy to take this one — one thing to clarify first so the guide documents something real.

I cloned main to trace the path from clone to verified page, and the repository currently contains public documentation only (README.md, CONTRIBUTING.md, ROADMAP.md, and the launch-kit/daily-social images) — there is no package.json or runnable source, and the README doesn't include npm commands anymore (it may have when this was written). CONTRIBUTING.md also notes the repo is docs-only until a reviewed portion of the codebase opens.

So before writing it: should this guide target (a) a future open-sourceable component you plan to publish under launch-kit/, or (b) the current docs-only workflow (e.g. previewing Markdown, validating links, the glossary review flow)? If (a), point me at the branch or package and I'll write the PowerShell/macOS/Linux guide against exactly that. If (b), I can draft that narrower version right away.

[rback37]

Thank you — you caught a real mismatch between Issue #9 and the current main branch.

Please target (b), the current docs-only workflow. Do not invent npm commands or document a package that has not been published. For this contribution, a useful 10-minute cross-platform guide can cover:

• cloning and updating the repository;
• previewing the Markdown files and checking relative links/images;
• making one small documentation or glossary edit on a branch;
• reviewing the diff for secrets, personal financial information, and unintended generated files; and
• opening a focused pull request.

Git should be the only required tool. An editor or browser preview can be optional, and platform-specific notes should be included only where Windows, macOS, and Linux genuinely differ. Please omit the Node.js, build, lint, and test steps from the current issue scope unless runnable source later lands on main.

A short note explaining that the repository is currently the public product-and-community home would also prevent the same confusion for the next contributor.

Thank you for checking the repository before writing the guide — this is exactly the kind of contributor-experience gap I wanted the issue to uncover. If this narrower scope still works for you, please go ahead.