docs: add project overview (linked from README) - #13
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
elirancv
changed the title
docs/OVERVIEW.md: neutral project document - what it is, who it is for, verifiable claims, setup A-to-Z, FAQ. No meta-marketing framing. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- New-to-WSL2 section opens with the real historical trade-off (pollute the host vs fight a VM) that WSL2 dissolved. - Engineers section positions the kit as workstation-as-code. - FAQ gains the dotfiles differentiation. - Standalone design-principle section folded into the isolation section (one idea, one place). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
"Fresh" excluded everyone with an existing PC (the kit is idempotent precisely so it works there too), and a reset command in the first benefit bullet implied resets are coming. Outcomes up top; script names stay in the reference docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
elirancv
changed the title
Two parallel what-is-this documents drift apart. The README absorbs the four pieces the overview added that it lacked: a collapsible new-to-WSL2 explainer with the isolation benefits, the workstation-as-code framing, a verify-the-claims table in Security & trust, and a short FAQ. One front door, one source of truth. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
elirancv
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds docs/OVERVIEW.md as the newcomer + verification landing page — one-sentence value, isolation benefits, new-to-WSL2 explainer, workstation-as-code engineer pitch, verify-the-claims table, A-to-Z setup, FAQ — linked from the README layout tree and Documentation section. README and overview hold disjoint content: README = operational front door; overview = orientation and claim-verification layer.
🤖 Generated with Claude Code