ProductBay Documentation

This is the official documentation site for ProductBay

Requirements

• Node.js 18+
• npm 8+

Getting Started

Install dependencies (first time only):

npm run docs:install

Start Dev Server

npm run docs:dev

Build for Production

npm run docs:build

Output is written to docs/.vitepress/dist/.

Preview Production Build

npm run docs:preview

Deployment

The docs are automatically deployed to GitHub Pages whenever changes to the docs/ directory are pushed to the main branch, via the workflow at .github/workflows/docs.yml.

To enable GitHub Pages on your repository:

1. Go to Settings → Pages
2. Set Source to GitHub Actions

Structure

docs/
├── .vitepress/         # VitePress config and custom theme
├── public/             # Static assets (logo, icon, screenshots)
├── guide/              # Getting started guides
├── features/           # Feature documentation
├── developer/          # Developer reference (architecture, REST API)
├── index.md            # Home / landing page
├── faq.md              # Frequently Asked Questions
├── changelog.md        # Free version changelog
├── pro-changelog.md    # Pro version changelog
├── known-issues.md     # Active limitations and known bugs
└── feature-request.md  # Template for requesting features