This repository uses MDX files for its documentation pages. To update the content, follow these steps:
- All documentation content should be stored in the
/contentfolder or in a direct subfolder, such as/content/example. - Note: Do not use multiple sublayers (e.g.,
/content/example/foo). Only one level of subfolders is supported.
- Open the
.mdxfile you want to update in your code editor. - Make your changes using Markdown and JSX as needed.
- Save the file.
- Create a new file with the
.mdxextension in the/contentfolder or a direct subfolder. - Add your content using Markdown and JSX.
- Save the file.
- If you have a local development environment set up, always use
pnpmto run commands. - Start the development server:
pnpm dev - Visit the local site in your browser to preview your updates.
- Stage your changes:
git add . - Commit your changes:
git commit -m "Update docs content" - Push to the repository:
git push
- Once changes are pushed, the site will be automatically redeployed (e.g., via Vercel) and your updates will go live.
Tip: Use clear commit messages and review your changes before pushing to keep the documentation organized and up to date.