Welcome to the official documentation repository for Notabeen — an open-source AI-powered email assistant that helps you take control of your inbox.
This repository contains the source code for the Notabeen documentation website, built with VitePress. The documentation provides comprehensive guides, tutorials, and references for using and contributing to Notabeen.
Visit the live documentation at: docs.notabeen.com (or your deployment URL)
- Clone the repository:
git clone https://github.com/yipfram/notabeen-docs.git
cd notabeen-docs- Install dependencies:
# Using pnpm (recommended)
pnpm install
# Or using npm
npm install
# Or using bun
bun install- Start the development server:
# Using pnpm
pnpm docs:dev
# Or using npm
npm run docs:dev
# Or using bun
bun run docs:dev- Open your browser and navigate to
http://localhost:5173
docs/
├── index.md # Home page
└── guide/
└── getting-started/
├── introduction.md # Introduction to Notabeen
└── installation.md # Installation guide
| Script | Description |
|---|---|
pnpm docs:dev |
Start the development server |
pnpm docs:build |
Build the documentation for production |
pnpm docs:preview |
Preview the production build locally |
We welcome contributions from the community! Whether you're fixing typos, improving existing documentation, or adding new guides, your help is appreciated.
Please read our Contributing Guidelines before submitting a pull request.
- Fork the repository
- Create a new branch (
git checkout -b docs/improve-installation-guide) - Make your changes
- Test locally with
pnpm docs:dev - Commit your changes (
git commit -m 'docs: improve installation guide') - Push to your branch (
git push origin docs/improve-installation-guide) - Open a Pull Request
- Write in clear, concise language
- Use proper Markdown formatting
- Include code examples where applicable
- Add screenshots or diagrams for complex concepts
- Follow the existing documentation structure
- Test all code examples before submitting
If you find an error in the documentation or have a suggestion for improvement:
- Check if an issue already exists
- If not, create a new issue
- Provide as much detail as possible
- Main Project: NotaBeen AI Email Assistant
- Website: notabeen.com
- Documentation: docs.notabeen.com
- Issues: GitHub Issues
This documentation is open source and available under the MIT License.
- Built with VitePress
- Powered by the Notabeen community
- Thanks to all contributors who help improve this documentation