Auto-updating user documentation for Vurvey - the AI-powered consumer insights platform.

• VitePress-powered documentation site with search
• Automated screenshots captured nightly via Puppeteer
• GitHub Actions workflow for CI/CD
• GitHub Pages deployment

📚 View Documentation

• Node.js 20+
• npm

# Clone the repository
git clone https://github.com/Batterii/vurvey-docs.git
cd vurvey-docs

# Install dependencies
npm install

# Start development server
npm run docs:dev

The site will be available at http://localhost:5173/vurvey-docs/

This repo runs two scheduled GitHub Actions workflows:

• Update Documentation (.github/workflows/update-docs.yml): captures screenshots and deploys GitHub Pages (2 AM UTC)
• Nightly Documentation Sync (.github/workflows/nightly-docs-sync.yml): captures screenshots, runs QA, proposes doc updates, and opens a PR (3 AM UTC)

Configure these secrets in your repository settings:

The staging app can occasionally show transient global errors like "Failed to fetch". The QA suite will retry route navigation automatically.

• QA_ROUTE_RETRIES (default: 3)

QA output files are written under qa-output/ (ignored by git).

You can manually trigger updates:

1. Go to Actions tab
2. Select "Update Documentation"
3. Click "Run workflow"

vurvey-docs/
├── docs/
│   ├── .vitepress/
│   │   └── config.js      # VitePress configuration
│   ├── public/
│   │   └── screenshots/   # Auto-captured screenshots
│   ├── guide/             # Documentation pages
│   └── index.md           # Home page
├── scripts/
│   └── capture-screenshots.js  # Puppeteer automation
├── .github/
│   └── workflows/
│       └── update-docs.yml     # CI/CD workflow
└── package.json

1. Create a new .md file in docs/guide/
2. Add it to the sidebar in docs/.vitepress/config.js
3. Commit and push

Screenshots update nightly. No action needed.

# Set credentials
export VURVEY_EMAIL="your-email@example.com"
export VURVEY_PASSWORD="your-password"

# Run screenshot capture
npm run update:screenshots

By default, screenshot capture is best-effort. To fail the run if login/workspace resolution fails:

CAPTURE_STRICT=true npm run update:screenshots

1. Edit scripts/capture-screenshots.js
2. Add new capture function following existing patterns
3. Reference new screenshots in documentation
4. Test locally before committing

Edit docs/.vitepress/config.js to:

• Update navigation and sidebar
• Change site title/description
• Add new pages
• Configure search

Edit scripts/capture-screenshots.js to:

• Change target URLs
• Add new pages to capture
• Adjust viewport size
• Modify capture timing

Deployment happens automatically via GitHub Actions when:

• Push to main branch
• Scheduled nightly update
• Manual workflow trigger

GitHub Pages serves the built site from the gh-pages environment.

1. Enable GitHub Pages in repository settings
2. Select "GitHub Actions" as the source
3. Add required secrets
4. Push to main branch

1. Fork the repository
2. Create a feature branch
3. Make changes
4. Test locally with npm run docs:dev
5. Submit a pull request

MIT License - See LICENSE for details.

Built with VitePress for Vurvey Labs