docs: Enhance project documentation and add AI guidance #18
Conversation
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
Member
SmetDenis
commented
Sep 27, 2025
SmetDenis
commented
- Add CLAUDE.md to provide detailed guidance for AI models on the project's structure, architecture, and common workflows.
- Significantly expand README.md to offer a more comprehensive overview for human developers. New sections include:
- Project features and installation instructions
- Detailed key components (VarDumper, development tools)
- Usage examples for development, testing, and debugging
- System requirements and integration patterns
- Add CLAUDE.md to provide detailed guidance for AI models on the project's structure, architecture, and common workflows.
- Significantly expand README.md to offer a more comprehensive overview for human developers. New sections include:
- Project features and installation instructions
- Detailed key components (VarDumper, development tools)
- Usage examples for development, testing, and debugging
- System requirements and integration patterns
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.