Skip to content

docs: rewrite README, remove Create React App leftovers - #175

Merged
magnus-madsen merged 1 commit into
masterfrom
readme-cleanup
Aug 3, 2026
Merged

docs: rewrite README, remove Create React App leftovers#175
magnus-madsen merged 1 commit into
masterfrom
readme-cleanup

Conversation

@magnus-madsen

Copy link
Copy Markdown
Member

Summary

Item 25 from the site audit: rewrites the README, which still carried Create React App boilerplate from before the Astro rewrite.

  • Remove the CRA "Available Scripts" structure and stock phrasing ("The build is minified and the filenames include the hashes...")
  • Fix the dev URL: the dev script binds 127.0.0.1:3000, not localhost:3000
  • Add a one-line project description, the Node.js 22 requirement (matching CI), and npm install as the first step
  • Document the fetch-grammar step that dev/build run, including that the download is skipped when src/grammars/flix.tmLanguage.json already exists
  • Keep the Astro and Bootstrap 4 documentation links

🤖 Generated with Claude Code

Replaces the CRA "Available Scripts" boilerplate with an accurate
description of the Astro setup: project intro, Node.js 22
requirement, correct dev URL (127.0.0.1:3000), and documentation
of the fetch-grammar build step.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@magnus-madsen
magnus-madsen merged commit 61dbb35 into master Aug 3, 2026
2 checks passed
@magnus-madsen
magnus-madsen deleted the readme-cleanup branch August 3, 2026 12:56
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.

1 participant