Unify project docs with CLAUDE.md as single source of truth#100
Open
dougborg wants to merge 1 commit intoFoggedLens:masterfrom
Open
Unify project docs with CLAUDE.md as single source of truth#100dougborg wants to merge 1 commit intoFoggedLens:masterfrom
dougborg wants to merge 1 commit intoFoggedLens:masterfrom
Conversation
- Add CLAUDE.md with full project documentation (quick start, build commands, repo layout, conventions, architecture, deployment, env vars) - Rewrite copilot-instructions.md as thin entry point that inlines conventions and references CLAUDE.md for depth - Fix README.md: replace stale Scala/shotgun tech stack and usage with current Fastify/Bun API, fix broken serverless/alpr_clusters link - Fix serverless/alpr_cache/README.md: rename from "ALPR Clusters" to "ALPR Cache", update description to match current tile-based approach - Fix serverless/README.md: "map clusters" -> "map tile caches" - Fix .gitignore: replace stale alpr_clusters.py exception with alpr_counts.py, add .claude/ directory Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR consolidates project documentation by introducing CLAUDE.md as the canonical source of truth, streamlining copilot-instructions.md to reference it, and fixing outdated technical references throughout the documentation. The changes eliminate stale references to the deprecated Scala/shotgun backend and correct serverless function naming from "clusters" to "cache."
Changes:
- Added comprehensive CLAUDE.md covering quick start, architecture, data flow, conventions, and deployment
- Rewrote copilot-instructions.md as a concise entry point that inlines critical coding conventions and references CLAUDE.md
- Updated README.md tech stack from deprecated Scala/PekkoHTTP to current Fastify+Bun API, fixed broken serverless links
- Corrected serverless README terminology from "ALPR Clusters" to "ALPR Cache" and "map clusters" to "map tile caches"
- Updated .gitignore to replace stale
alpr_clusters.pywithalpr_counts.pyand added.claude/directory
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| CLAUDE.md | New comprehensive documentation file covering project structure, commands, architecture, and conventions |
| .github/copilot-instructions.md | Streamlined to inline coding conventions and reference CLAUDE.md for detailed documentation |
| README.md | Updated tech stack from Scala/shotgun to Fastify/Bun, fixed serverless links, corrected API running instructions |
| serverless/README.md | Updated terminology from "map clusters" to "map tile caches" |
| serverless/alpr_cache/README.md | Updated title and description from "ALPR Clusters" to "ALPR Cache" with accurate tile-based description |
| .gitignore | Corrected serverless file exceptions from alpr_clusters.py to alpr_counts.py, added .claude/ directory |
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
serverless/alpr_clusterslink toserverless/alpr_cache, removed references to non-existent root Dockerfilesrc/subdirectories (alpr_counts.py,alpr_cache.py)alpr_clusters.pyexception withalpr_counts.py, added.claude/directoryTest plan
grep -r "alpr_clusters\|sbt run" --include="*.md" .returns no matches (onlyshotgunin deprecation guardrails)serverless/alpr_cache,serverless/alpr_counts,serverless/blog_scrapernpm run build --prefix webappsucceeds🤖 Generated with Claude Code