docs: refresh dash README to house style#29
Draft
ashpreetbedi wants to merge 1 commit into
Draft
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
🤖 Automated re-review
|
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.
Summary
Docs-only refresh of README.md to the house style (tagline → intro → How it works → Quick start → Interfaces → Deploy → Configuration → Evals → Links). Every command was verified against the current code (compose.yaml, scripts/, app/main.py, evals/main.py, example.env, railway.json). No code changes.
Changes
dash/team.py,dash/agents/,db/session.py,dash/tools/build.py.PORTenv var from the configuration table — nothing reads it; port 8000 is hardcoded in compose.yaml and railway.jsonstartCommand.numReplicas: 1in railway.json) and that production boot requiresJWT_VERIFICATION_KEY(authorization is enabled whenRUNTIME_ENV=prd, the default; app crash-loops until the key is set).evals/__main__.py:--category,--verbose, plus thesmokeandimprovesubcommands (previously undocumented).knowledge-refreshdaily scheduled task (04:00 UTC) registered inapp/main.py.railway_up.sh→ JWT key →railway_env.sh→railway_redeploy.sh,railway ssh --service dashfor in-network data scripts), Slack pointer to docs/SLACK_CONNECT.md, and quick-start commands unchanged in substance.Non-doc issues spotted (NOT changed — for reviewer)
pyproject.tomllistsmcpas a dependency but nothing in the codebase imports it; likely removable (belongs in the dependency-bump PR, not this docs PR).compose.yaml/railway.jsonhardcode port 8000 while old README implied aPORTenv var; if configurable port is desired, that's a code change.Orthogonal to the open
chore/update-*bump PR; contains no version or code changes.🤖 Generated with Claude Code