docs: refactor documentation for v2 - #136
Merged
Merged
Conversation
CLAUDE.md: - Update project name to Fulling v2 - Refine core value: free users' mental bandwidth through AI Agents - Add Project Structure section - Remove implementation details from Key Design Decisions - Update code style guidelines (self-documenting code) - Remove specific image version references README.md: - Rewrite from user perspective (not developer perspective) - Add "What is Fulling?" section with clear value proposition - Add "Configuration-driven development" messaging - Simplify Features section (focus on user benefits) - Replace Tech Stack with "Built With" (minimal, no versions) - Replace Installation with "Self-Hosting" (for contributors) - Remove redundant env variable list (point to .env.template) - Move "Star us" to end of file - Update footer with model credits docs/: - Remove api.md (code is the best documentation) - Remove database.md (schema is self-documenting) - Add architecture.md, development.md, operations.md, troubleshooting.md
✅ PR Check Results: PassedBuild Checks
✨ Great work!All checks passed successfully. Your PR is ready for review. Details:
🔗 View Details: |
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
1 participant
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
Refactor documentation to reflect Fulling v2 vision and improve clarity for different audiences.
CLAUDE.md (850+ → 155 lines, -82%)
README.md (Rewrite)
docs/
Test Plan