docs: Comprehensive README rewrite following documentation guidelines #178
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
- Add clear purpose statement in first sentence - Add table of contents for easy navigation - Include detailed project structure explanation - Document both REST and GraphQL API support - Add copy-pasteable quick start and Docker commands - Document database, security, testing, and code formatting - Add contribution guidelines and license information - Include attribution as per documentation standards Co-Authored-By: Cindy Huang <cindy.huang@cognition.ai>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Update actions/checkout from v2 to v4 - Update actions/setup-java from v2 to v4 - Update actions/cache from v2 to v4 These updates are required as v2 versions have been deprecated and are causing CI failures. Co-Authored-By: Cindy Huang <cindy.huang@cognition.ai>
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.
Summary
This PR rewrites the README.md following comprehensive documentation guidelines and fixes a CI issue with deprecated GitHub Actions.
README Changes:
CI Fix:
Review & Testing Checklist for Human
src/main/java/io/spring/directory structure./gradlew bootRunstarts the application andhttp://localhost:8080/tagsreturns a response/graphqland/graphiqlas documentedsrc/main/resources/db/migrationas statedRecommended test plan: Run
./gradlew bootRunlocally, then verify the tags endpoint works withcurl http://localhost:8080/tags. Optionally test the GraphQL endpoint athttp://localhost:8080/graphiql.Notes
The README was rewritten from scratch following a documentation playbook, so all content should be reviewed for accuracy against the actual codebase.
Requested by: Cindy Huang (@cindyyhuang)
Devin Session: https://app.devin.ai/sessions/7ca3ee49aa8047b788666047ccea7916