docs: remove QUICKSTART.md (redundant with DEMO.md)#45
Merged
Conversation
Deleted QUICKSTART.md because: - 60% overlap with DEMO.md (setup, health checks, troubleshooting) - DEMO.md is more practical (shows actual usage, not just setup) - User confusion: "Which do I follow?" - DEMO.md already includes full setup walkthrough QUICKSTART unique content was primarily: - Local dev without Docker (belongs in main README or DEVELOPMENT.md) - Command reference (already in main README) - Database schema (already in API.md) - Outdated "Next Steps" referencing old milestones Updated docs/README.md: - Removed QUICKSTART.md from API & Usage section - Removed from file tree diagram - Changed "Get started quickly" to point to DEMO.md - Clarified DEMO.md includes setup DEMO.md is now the single entry point for new users. File count: 11 docs (down from 12)
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.
Summary
Removes QUICKSTART.md as it's 60% redundant with DEMO.md and causes user confusion about which guide to follow first.
Why Delete QUICKSTART.md?
Significant Overlap (60%)
Both guides cover:
docker compose up)alembic upgrade head)DEMO.md is Superior
DEMO.md advantages:
QUICKSTART.md drawbacks:
What About Unique Content?
QUICKSTART.md's unique sections can be relocated:
Changes Made
Deleted File:
docs/QUICKSTART.md(390 lines)Updated References in
docs/README.md:New User Flow
Before (confusing):
After (clear):
Statistics
Testing
Impact
Future Consideration
If we need detailed local development docs (UV setup, hot reload, testing workflow), we can create a focused DEVELOPMENT.md guide. For now, DEMO.md + main README are sufficient.