Skip to content

Conversation

@delphiactual
Copy link
Collaborator

@delphiactual delphiactual commented Nov 18, 2025

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

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
@chainrez
Copy link
Contributor

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants