feat: create workflow for generating previews and publishing docs using fern #1500
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
How to use the Graphite Merge QueueAdd the label graphite-merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
🌿 Documentation Preview
|
| "import/extensions": ["off", "ignorePackages"] | ||
| "rules": { | ||
| "import/extensions": ["off", "ignorePackages"], | ||
| "react/jsx-no-undef": "off" |
There was a problem hiding this comment.
Fern components are imported automatically. So this rule was incorrectly throwing errors everywhere
| - name: Download Alchemy Docs Repo | ||
| run: | | ||
| rm -rf docs-site && \ | ||
| curl -L -f -H "Authorization: token ${{ secrets.DOCS_GITHUB_TOKEN }}" \ |
There was a problem hiding this comment.
This is a classic GitHub Token I supplied to allow us to access the currently private docs repo. We should remove it once the docs are made public.
| @@ -38,6 +38,7 @@ | |||
| "build:esm": "tsc --project tsconfig.build.json --outDir ./dist/esm", | |||
| "build:types": "tsc --project tsconfig.build.json --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap", | |||
| "docs:gen": "node ../../doc-gen/dist/esm/cli.js generate --in ./src/index.ts --out ../../site/pages/reference/aa-sdk/core", | |||
| "fern:gen": "node ../../fern-gen/dist/esm/cli.js generate --in ./src/index.ts --out ../../docs/pages/reference/aa-sdk/core", | |||
There was a problem hiding this comment.
Once we deprecate the vocs site I'd prefer we rename this docs:gen.
| <CardGroup cols={2}> | ||
| <Card title="Quickstart" href="/react/quickstart" icon="forward"> | ||
| Start building in minutes with UI components and powerful React hooks. | ||
| </Card> | ||
| <Card | ||
| title="Try the Demo" | ||
| href="https://demo.alchemy.com/" | ||
| icon="bullseye-pointer" | ||
| > | ||
| Customize React components, export your config, and start building. | ||
| </Card> | ||
| </CardGroup> |
There was a problem hiding this comment.
These are Fern components
There was a problem hiding this comment.
This script will be used on docs repo as well
dslovinsky
requested review from
moldy530,
rthomare,
dancoombs,
dphilipson,
linnall,
adamegyed,
howydev,
Zer0dot,
jaypaik,
Blu-J,
noam-alchemy,
jakehobbs,
florrdv and
blakecduncan
as code owners
dslovinsky
changed the title
See this readme to understand how to make docs changes using this process.
This PR does a few things to integrate Account Kit into the new docs using Fern:
docs-genpackage and its command asfern-genwhich includes Fern-specific syntax.docswhich is essentially a copy ofsitebut only including files necessary for Fern (markdown, images, etc). All vocs-related files are removed.docsdirectory ONLY includes one example markdown page for now. The rest will be migrated once the content freeze begins.docs.ymlfile determines nav structure. It is injected into Fern's docs.yml in the preview and publish GitHub workflows.Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR primarily introduces updates to the documentation and configuration for the
Account Kitproject. It enhances the documentation structure, adds new icons, and integrates with theFernCLI for generating documentation.Detailed summary
docs/images/.DotsIcon,ClockForwardIcon,ExpoIcon,SignerIcon,ReactNativeIcon,InfraIcon, andSmartContractIconcomponents.package.jsonfiles for various packages to includefern:gencommands.fern-genconfiguration files for TypeScript and documentation generation.README.mdandindex.mdxwith detailed instructions for documentation updates.