Conversation
|
Thank you for your contribution to Dash! 🎉 This PR is exempt from requiring a linked issue due to its labels. |
|
Who is the audience for the docs? Is it MCP/LLM runtime docs? The COMMANDS.md TESTING.md and RENDERER.md seems like it's more relevant to a dash contributor. How was the file generated? The TROUBLESHOOTING.md looks shallow and some of it is incorrect, for example: |
It's AI generated and for AI agents like claude. It is meant to describe the project context. The TESTING describe how dash_duo works since it's part of the framework. If it's useful to a dash contributor then I think it's doing a good job. The TROUBLESHOOTING part I was not really sure, it was a suggestion from claude to add it. If you notice incorrect info please add in a review. |
|
OK - I thought this was docs for the MCP server. For dash contributors, this looks good. Not sure how useful the troubleshooing part is for this use-case. |
AGENTS.md
Outdated
| ## Quick Reference | ||
|
|
||
| ```bash | ||
| # Setup | ||
| pip install -e .[ci,dev,testing,celery,diskcache] && npm ci | ||
|
|
||
| # Build | ||
| npm run build # Linux/Mac | ||
| npm run first-build # Windows (use Bash) | ||
| dash-update-components "dash-core-components" # Single component | ||
|
|
||
| # Test | ||
| pytest tests/unit # Unit tests | ||
| pytest tests/integration # Integration tests | ||
| pytest -k test_name # Specific test | ||
|
|
||
| # Lint | ||
| npm run lint # All linters | ||
| npm run private::format.black # Auto-format Python | ||
| ``` |
There was a problem hiding this comment.
I don't think that it's actually useful to provide this section. LLMs are pretty good at taking in all the docs, and it's likely that this section will become out-of-sync with the other example commands when we update them.
Co-authored-by: Adrian Borrmann <adrian.borrmann@plot.ly>
| ```bash | ||
| # Run all tests | ||
| npm run test | ||
|
|
||
| # Unit tests only | ||
| pytest tests/unit | ||
|
|
||
| # Integration tests (requires ChromeDriver) | ||
| pytest tests/integration | ||
|
|
||
| # Run specific test by name | ||
| pytest -k test_name | ||
|
|
||
| # Run tests matching pattern | ||
| pytest -k cbcx # runs all tests with "cbcx" in name | ||
|
|
||
| # Renderer unit tests (Jest) | ||
| cd dash/dash-renderer && npm run test | ||
|
|
||
| # Setup test components before running integration tests | ||
| npm run setup-tests.py | ||
| ``` |
There was a problem hiding this comment.
similar to the "Quick Reference" I don't think we should have duplicate examples.
3 participants
Add claude/ai agents documentation for the project.