Repository navigation
docs: revamp README as world-class open-source project landing page - #15
Merged
Merged
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
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.
📝 Description
This PR revamps the project
README.mdto transform it from an exhaustive internal reference manual into an open-source project landing page optimized for developer comprehension, curiosity, and fast local adoption.🎯 Key Enhancements
Clear Hero Positioning:
The Magic Example as the Hero:
schemas/Product.graphqlexample."Who is AutoGraphQL for?" & "It may not be for you if...":
Quick Start UX:
npm run db:up)./studio,/graphql/core,/health/live,/health/ready) and repository resources.Visual Control Plane (AutoGraphQL Studio):
docs/studio-user-guide.mdfor deep documentation.Architecture & "What Happens Under the Hood?":
Directives & Documentation Architecture:
@model,@relation,@tenantScoped,@ownerScoped,@userPermissions,@unique,@defaultValue,@cacheControl).docs/.🔍 Verification & Audit
file://andvscode-resourceURLs; verified all relative paths exist on disk).npm test).schema:diffexits with code 0).