docs: improve onboarding with three-path structure and precise project positioning#11
Open
allmonday wants to merge 1 commit into
Open
docs: improve onboarding with three-path structure and precise project positioning#11allmonday wants to merge 1 commit into
allmonday wants to merge 1 commit into
Conversation
…t positioning - Rewrite docs/index.md: three-path entry with mermaid diagram + quick code blocks - Rewrite docs/guide/quick_start.md: three parallel quick starts (GraphQL / REST / MCP) - Rewrite package __init__.py docstring: precise positioning + ASCII art path tree - Update CLAUDE.md project positioning to match - Add 'Prerequisites' + 'Live demo' sections to all guide and advanced pages - Add demo file references (with direct GitHub links) to Core API docs - Clean up Core API docs: remove redundant duplicate content, add build_dto_select tip - Core API Advanced: merge custom relationships section, add execution order summary
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
Rewrite the project onboarding experience — make it obvious what sqlmodel-nexus does in under 5 seconds, and let users immediately pick the path that fits their use case.
Changes
Positioning (3 files)
src/sqlmodel_nexus/__init__.py— docstring rewritten: one-line position + ASCII art three-path tree + 8 core capabilitiesCLAUDE.md— updated to match new positioningdocs/index.md— full rewrite: Mermaid diagram, three-column path comparison table, 13-line quick-start code blocks for each path, 5-level demo progression table, API reference tableQuick Start → Three Parallel Paths
docs/guide/quick_start.md— from single GraphQL-only quick start to three parallel paths (GraphQL / REST Core API / MCP UseCase), each self-contained with code + expected outputPrerequisites + Demo References (all guide/advanced pages)
Every guide page now starts with prerequisites and live demo reference.
Pages updated:
graphql_mode.md,core_api.md,core_api_advanced.md,advanced/use_case_service.md,advanced/use_case_fastapi.md,advanced/mcp_service.md,advanced/voyager.mdEditorial Cleanup
docs/guide/core_api.md— removed redundant content duplicated from core_api_advanced.md, addedbuild_dto_selecttipdocs/guide/core_api_advanced.md— merged Custom Relationships section inline, added demo level references, added full execution order summary