Repository navigation
npm-ready client + Fumadocs docs site (client + OpenAPI) - #7
Merged
Merged
Conversation
- Publish metadata, LICENSE, and CI workflow for @timeforschool/client - Add apps/docs Next.js + Fumadocs site with client guides and OpenAPI pages - Export OpenAPI from Elysia via scripts/export-openapi.ts and openapi:sync Co-authored-by: Injoon Oh <injoon5@icloud.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add docs/vercel-deploy.md (two-project API + docs strategy) - Add AGENTS.md and .cursor/rules for openapi:sync on API changes - Add sync-docs workflow: PR check + auto-commit on main Co-authored-by: Injoon Oh <injoon5@icloud.com>
Co-authored-by: Injoon Oh <injoon5@icloud.com>
injoon5
marked this pull request as ready for review
May 26, 2026 15:35
This branch was successfully deployed
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
Prepares
@timeforschool/clientfor npm publishing and adds a Fumadocs + Next.js documentation site covering both the TypeScript client and the generated HTTP API reference.New in latest commit: Vercel deployment plan, agent instructions, and CI doc sync.
npm (
@timeforschool/client)publishConfig.access: public,sideEffects: falseLICENSE,prepackbuild hookNPM_TOKENrequired)Docs (
apps/docs)/docs/client/*)fumadocs-openapipages generated from Elysia spec (/docs/api/*)npm run openapi:syncexportsapps/docs/openapi/openapi.jsonfrom the running Elysia app and regenerates API MDXVercel (two projects)
.api.timefor.schoolapps/docstimefor.schoolordocs.timefor.schoolSee docs/vercel-deploy.md for step-by-step setup.
Agent / CI doc sync
npm run openapi:syncwhen changingsrc/API code.cursor/rules/sync-openapi-docs.mdc— Cursor rule onsrc/**edits.github/workflows/sync-docs.yml— PR fails if docs stale;mainauto-commits sync when API changesCommands
Follow-up
@timeforschoolnpm org andNPM_TOKENsecret