-
Notifications
You must be signed in to change notification settings - Fork 20
Improve documentation and add contributing guide #811
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
README.md improvements: - Add project description and link to DIM - Add prerequisites section (Node.js >=22, pnpm >=10, API key) - Improve command documentation with better examples - Rewrite "Output Files" section with clearer descriptions - Remove outdated husky v8 troubleshooting - Add documentation links section CONTRIBUTING.md (new): - Comprehensive contributing guide for new contributors - Setup instructions and development workflow - Code style guidelines and project structure overview - Generator script creation guide with module caching pattern - Testing, commit, and PR guidelines - Common tasks and troubleshooting - Golden rule: never manually edit JSON files
|
In true LLM fashion, I am assuming from sheer amount of text and cheerful emojis, this is exhaustingly much to read. I feel like some of it covers the very concept of reading and understanding code, the concept of troubleshooting etc, like explaining to console log things seems outside of the purview of "how to change something in specifically d2ai." But on the whole a net positive in terms of explanation. |
- Remove verbose explanations and basic programming advice - Clarify script-name format for generate-data-sub command - Remove API_KEY setup instructions - Add Discord as help resource - Remove debugging section (too basic) - Simplify workflow steps and PR guidelines - Remove emoji and unnecessary examples - Add verification step for unexpected output changes - Note that Prettier runs automatically on commit
README.md improvements:
API key)CONTRIBUTING.md (new):