docs: add Docusaurus documentation site deployed via GitHub Pages#322
Merged
Conversation
The README had grown to ~1500 lines covering every feature inline, which the maintainer flagged as unwieldy in jeremydaly#27. This adds a dedicated, searchable Docusaurus v3 site under website/ and slims the README to an overview that links to it. - Migrate all README content into ~36 organized doc pages across 8 categories (Getting Started, Core Concepts, Request & Response, Middleware & Errors, Logging, Deployment & Integrations, TypeScript, API Reference), preserving every code example. - Modern amber/orange theme matching the Lambda API brand, custom homepage with hero + feature cards, dark mode, offline local search, Mermaid diagram, and Tabs for multi-variant examples. - Vendor the official logo locally; add a branded favicon and social card. - Deploy to GitHub Pages from website/ via a GitHub Actions workflow (upload-pages-artifact + deploy-pages). - Exclude the self-contained website/ sub-project from root eslint/prettier. Closes jeremydaly#27 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The logo already reads "Lambda API", so the navbar title text was redundant. Also drop the Stack Overflow and GitHub Discussions footer links, leaving Issues as the Community entry. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Trim the "More" footer column to just GitHub and npm (dropping Issues, Releases, and License, which are all reachable from GitHub), and reset Infima's full-width footer columns so "Docs" and "More" sit next to each other on the left instead of stretching across the full width. Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
Closes #27
The README had grown to ~1,500 lines covering every feature inline — exactly the "getting a bit unwieldy" problem called out in #27. This PR moves that content into a dedicated, modern, searchable Docusaurus v3 site under
website/, deploys it to GitHub Pages, and slims the README down to a concise overview that links to the site.What's included
Tabsfor multi-variant examples (JS/TS, npm/yarn/pnpm, async/await vs Promises, API Gateway v1 vs v2), admonitions for notes/warnings, a Mermaid diagram for execution stacks, and copy-code buttons.assets/lambda-api-logo.png+website/static/img/), with a branded favicon and social card..github/workflows/deploy-docs.ymlbuildswebsite/and publishes via the officialupload-pages-artifact+deploy-pagesflow on pushes tomainthat touchwebsite/.website/sub-project is excluded from the root ESLint/Prettier so existing CI stays green.The site builds with
onBrokenLinks: 'throw', so a cleannpm run buildverifies there are no broken internal links.GitHub Pages must be enabled for the deploy to publish: Settings → Pages → Build and deployment → Source → GitHub Actions. Once set, the workflow publishes to https://jeremydaly.github.io/lambda-api/ (which is what
url/baseUrlindocusaurus.config.tsare configured for).Verification
cd website && npm ci && npm run build— succeeds, zero broken linksnpm run typecheck— passes