fix typos, update docs - #3
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to reflect the current runtime defaults and configuration surface of the Dash app (notably the default port and environment variables), and refreshes a few repo-reference docs/templates accordingly.
Changes:
- Update local run instructions to use port
5050(matchingsrc/app.py’s defaultPORT). - Refresh configuration docs to list the current
.envvariables (DASH_DEBUG,PORT,MOCK_PLATFORM_HEADER,MOCK_PLATFORM_SPACER,LOG_MEMORY). - Add
memory_log.pyto the documented repository file structure and simplify the PR template’s “definition of done” preamble.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates run URL/port and documents the full .env configuration set; adds memory_log.py to the repo layout section. |
| CONTRIBUTING.md | Updates the “run the app” note to reflect :5050. |
| CLAUDE.md | Updates the documented file structure to include memory_log.py. |
| .github/pull_request_template.md | Simplifies the “Definition of done” preamble while keeping the checklist intact. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What changed
Fix typos and update docs that I had forgotten to do.
Why
There were inconsistencies and typos in the docs.
Definition of done
CI covers the first two. The rest are yours — tick them because you did them,
not because they were already ticked. See
CONTRIBUTING.mdfor why each is here.pytestpassesblackis clean.env.example, not hardcoded (unless it'sa documented, deliberate simplification - see README)
CLAUDE.mdupdated if this establishes a new convention,README.mdif itchanges how to run, refresh or deploy anything
Anything the reviewer should look at closely
Make sure contributing and readme match the current version of the app