[WIP] docs: rewrite documentation site with Docusaurus#1507
Draft
jeffredodd wants to merge 2 commits intomainfrom
Draft
[WIP] docs: rewrite documentation site with Docusaurus#1507jeffredodd wants to merge 2 commits intomainfrom
jeffredodd wants to merge 2 commits intomainfrom
Conversation
Set up Docusaurus site with API reference docs generated from OpenAPI spec, update existing markdown docs for Docusaurus compatibility, and add website configuration with custom theming and sidebar structure. Made-with: Cursor
- Add quickstart section (install, first flow, next steps) - Add concepts section (flows/blocks, provider, events, auth, composition, theming, errors, i18n) - Add complete component inventory with individual pages for every flow and block - Add consolidated guides (routing, observability, component adapter, proxy setup, theme variables) - Rewrite sidebar, landing page, footer, and README to match new structure - Fact-checked all props, events, code examples, and flow steps against source code Made-with: Cursor
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
New Docusaurus-powered documentation site for the Gusto Embedded React SDK, designed to publish to ReadMe and give partners a best-in-class developer experience.
What's here
npm installto a working component on screen, including proxy setupWhy Docusaurus
Fact-checked against source
5 verification passes were run against the TypeScript source code:
componentEventsconstants (all 244 events)onboardingStateMachine.ts, etc.)Stats
docs/quickstart/,docs/concepts/,docs/components/, anddocs/guides/sidebars.ts,docusaurus.config.ts,index.tsx,README.md,what-is-the-gep-react-sdk.mdInformation Architecture
Still to do
docs/workflows-overview/,docs/integration-guide/,docs/getting-started/, etc.)How to preview locally
Screenshots