docs(frontend): improve README with project context and missing sections #466
Conversation
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
- Add project description explaining fAIr's humanitarian purpose - Fix typo: 'git https://' -> 'git clone https://' - Add Prerequisites section with Node and pnpm requirements - Add Testing section documenting vitest commands - Add Docker Development section for containerized development - Add preview command documentation - Improve ESLint and Prettier documentation with actual commands - Update Table of Contents with new sections Closes hotosm#130 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Member
|
Thanks for the PR @EricGrill , your PR is placed under review ! |
jeafreezy
approved these changes
Jan 18, 2026
Collaborator
jeafreezy
left a comment
jeafreezy
left a comment
There was a problem hiding this comment.
Thank you for your contribution @EricGrill !
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Improves the frontend README documentation by:
git https://→git clone https://)pnpm test,pnpm coverage)pnpm previewcommand documentationCloses #130
Test plan
🤖 Generated with Claude Code