Correct and expand feature list in project documentation - #257
Closed
richardthe3rd with Copilot wants to merge 1 commit into
Closed
Correct and expand feature list in project documentation#257richardthe3rd with Copilot wants to merge 1 commit into
richardthe3rd with Copilot wants to merge 1 commit into
Conversation
Agent-Logs-Url: https://github.com/richardthe3rd/cambridge-beer-festival-app/sessions/58d41a14-d3ff-4dc6-be8a-8e292ad4aa2d Co-authored-by: richardthe3rd <573334+richardthe3rd@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
richardthe3rd
May 11, 2026 19:03
View session
richardthe3rd
marked this pull request as ready for review
May 11, 2026 19:03
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README’s setup/workflow documentation to align with the repo’s current mise-based task approach, adds more explicit task commands, and refreshes the documented project structure/testing sections.
Changes:
- Reworks “Getting Started” to prefer
./bin/misetasks (including dev env viaMISE_ENV=dev). - Expands documented task list (generate/analyze/test/coverage, web build, e2e).
- Updates the documented directory structure and testing/coverage notes (including E2E commands).
Comment on lines
62
to
66
| ### Development Tasks | ||
|
|
||
| If using mise, you can run these convenient tasks: | ||
| The repository standard is to use `./bin/mise`: | ||
|
|
||
| ```bash |
Comment on lines
+43
to
+55
| # Discover available tasks | ||
| ./bin/mise tasks ls | ||
| MISE_ENV=dev ./bin/mise tasks ls | ||
|
|
||
| # Option 2: Manual setup | ||
| flutter pub get | ||
| # Install managed tools | ||
| ./bin/mise install | ||
|
|
||
| # Run core checks | ||
| ./bin/mise run test | ||
| ./bin/mise run analyze | ||
|
|
||
| # Run the app | ||
| flutter run | ||
| # Start the web dev server | ||
| MISE_ENV=dev ./bin/mise run dev |
Comment on lines
+144
to
+149
| ```bash | ||
| MISE_ENV=dev ./bin/mise run setup:playwright | ||
| MISE_ENV=dev ./bin/mise run build:web | ||
| MISE_ENV=dev ./bin/mise run serve:release | ||
| MISE_ENV=dev ./bin/mise run test:e2e | ||
| ``` |
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
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.
The documented feature list was stale: it omitted several shipped capabilities and used beer-specific wording in places where the app now supports multiple drink types and festival-level navigation. This update brings the feature summary back in line with the current product surface area.
Scope
Feature coverage updates
Terminology cleanup
brewery→brewery/producerwhere appropriatebeer/beers→drink/drinkswhere the feature applies across categoriesExample