Frequently Asked Questions
Answers to common questions about using and contributing to our documentation.
Last updated: July 1, 2025
General Documentation Questions
What does this documentation cover?
This documentation covers everything you need to know about using our product—from getting started and using core features to advanced topics and API references.
How is the documentation structured?
The docs are organized into several categories:
- Getting Started: Installation, setup, and first steps
- Components: UI elements and usage patterns
- Examples: Real-world implementation examples
- Help & Support: Troubleshooting and assistance
You can browse these from the sidebar or use the search bar for quick navigation.
How do I search the documentation?
Use the keyboard shortcut Cmd + K (Mac) or Ctrl + K (Windows) to open the search modal. Results will include pages, sections, and component references.
Is there a dark mode for the docs?
Yes, our documentation fully supports light and dark themes. Your system preference is respected automatically, but you can toggle it manually using the button in the top-right corner.
Contributing to Documentation
Can I contribute to the documentation?
Absolutely! Our docs are open-source and live in a public repository. We welcome contributions, fixes, and improvements via pull requests.
What format is used for writing docs?
We use Markdown (.md) and MDX (.mdx) files. Each page includes frontmatter metadata like title, description, category, and order for navigation.
Can I document my own components?
Yes. If you’ve built a custom component or utility that benefits others, you’re encouraged to write usage examples and submit a documentation entry for review.
Is there a documentation style guide?
Yes, we follow a clear and consistent tone:
- Write in active voice
- Keep sentences short and direct
- Use code blocks for all examples
- Prefer headings and lists for readability
You can find our full style guide in the /docs/contributing section.
Technical Documentation Features
How does code highlighting work?
We use Shiki for syntax highlighting. Code blocks support line numbers, diffs, and focus lines. All themes support light and dark mode, and you can annotate code for tutorials using special comments.
Are interactive previews supported?
Some component pages include live previews powered by lightweight client-side scripts. These are especially useful for buttons, forms, and layout utilities.
Is documentation versioned?
Currently, our docs reflect the latest stable release. Older versions may be tagged in the Git repository, but only the current version is actively maintained.
What should I do if I find a broken link?
If you encounter a broken or outdated link:
- Open an issue on the documentation repository
- Include the page URL and a brief description
- (Optional) Suggest a correction via PR
We regularly review and fix reported issues.
About the Docs Site
What is the documentation site built with?
This documentation is built using Astro, Tailwind CSS, and Shiki for code highlighting. It uses static content collections for fast, secure rendering and excellent SEO.
How can I leave feedback on a page?
Most pages include a feedback button at the bottom. You can vote up/down or leave a short message. This helps us prioritize updates and improvements.
How often is the documentation updated?
We update the docs regularly:
- Bug fixes and typo corrections are deployed weekly
- New features and components are documented with each major release
- Contributions from the community are reviewed and merged daily
Each page shows a lastUpdated timestamp for transparency.
Can I use the docs offline?
Not yet — but a downloadable offline version is in the works. If this feature is important to you, let us know in the feedback section.