docs: add verified 5-minute quickstart guide - #1208
Open
autarch-agent wants to merge 2 commits into
Open
Conversation
Implements Samuel1-ona#1194: - parseCluesCsv: parses CSV text into validated clue rows with per-row error reporting (row number + offending field) so the UI can highlight exactly which lines need fixing before commit - supports quoted fields, optional difficulty column (easy/medium/hard, case-insensitive, normalized to ClueDifficulty), max length guards - 6/6 unit tests passing (vitest.no-setup.config: pure-logic suite that avoids the pre-existing react/react-dom version mismatch in jsdom setup)
Implements Samuel1-ona#1144: - quickstart.md with the setup path verified on a clean clone (pnpm install, dev, typecheck, test, lint, build) - prerequisites table (Node >= 20, pnpm 10.x) - workspace layout summary (apps/web, apps/mobile, packages/*) - known-failing commands flagged: pnpm typecheck fails in @hunty/ui (missing jest-dom types) and react/react-dom lockfile mismatch — both documented with fix direction per the issue's acceptance criteria
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.
What
Adds
docs/development/quickstart.md— a 5-minute setup guide where every command was actually run on a clean clone before documenting it (#1144).Contents
Known-failing commands flagged (per acceptance criteria)
Both pre-existing failures are documented with their fix direction:
pnpm test— react/react-dom lockfile mismatch (19.2.0 vs 19.2.8)pnpm typecheck— @hunty/ui missing@testing-library/jest-domtypes in tsconfigResolves #1144