Add developer documentation (REFERENCE.md and GUIDE.md)#12
Open
AlexKempen wants to merge 3 commits into
Open
Conversation
REFERENCE.md covers the overall system: what the app is, the tech stack, all five Cloudflare services (D1, KV, R2, Workflows, Assets), the full OAuth auth flow, storage at a glance, a codebase map, and access levels. GUIDE.md covers common development tasks for new contributors: using the Onshape Glassworks API Explorer, understanding Onshape document paths, adding new Onshape API wrappers, adding backend routes, modifying the DB schema with Drizzle, adding frontend routes with TanStack Router, and wiring up frontend data fetches with React Query. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JyPYTnfrcQbhgG76Z7bKYm
Covers JSX components, the .ts vs .tsx distinction and Vite Fast Refresh export constraint, factoring out composable components, hooks and the rules of hooks (with React docs link), custom hooks, and how SCSS/Mantine styling works in the project. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
2 participants
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
Adds two Markdown documentation files under
docs/aimed at new contributors who may not be familiar with Cloudflare Workers, Hono, or TanStack Router.docs/REFERENCE.md— System reference for understanding the app. Covers what the app is, the full tech stack with plain-language explanations, all five Cloudflare services (D1, KV, R2, Workflows, Assets) and why each is used, the complete OAuth auth flow step-by-step, a storage-at-a-glance table, a full codebase map with one-line descriptions per file/directory, and access levels (ADMIN/EDITOR/USER).docs/GUIDE.md— Developer task guide for implementing new features. Covers using the Onshape Glassworks API Explorer, understanding Onshape document paths (DocumentPath/InstancePath/ElementPathandapiPath()), adding new Onshape API wrapper functions, adding new backend Hono routes, modifying the Drizzle DB schema and generating migrations, adding TanStack Router frontend routes, and wiring up React Query data fetches and mutations.Test plan
apiPath()calls,queryOptionsusage)🤖 Generated with Claude Code
https://claude.ai/code/session_01JyPYTnfrcQbhgG76Z7bKYm
Generated by Claude Code