Documentation Map
Map of the VeriWorkly documentation — product guides, architecture deep-dives, operations runbooks, and the API reference.
Documentation Map
VeriWorkly is a privacy-first career workspace: resume and cover letter building, a public portfolio builder, ATS scoring, AI writing assistance, and the shared Master Profile that connects them. This documentation covers both the product's actual behaviour and the engineering behind it.
Machine-Readable Index
A machine-readable summary of this documentation is available at docs.veriworkly.com/llms.txt.
Product Guides
How the shipped product actually behaves — quotas, gating, edge cases, and known mismatches.
Master Profile
The canonical career record, how it seeds documents, and the one-way rule.
Importing Your Profile
GitHub is real OAuth; LinkedIn is an AI-parsed paste. Quotas differ per path.
Cover Letter Builder
Templates, schema, and where cover letters diverge from resumes.
Portfolio Builder
Templates, the three-pane editor, publishing, subdomains, and analytics.
ATS Checker
The deterministic core scan, the AI deep-analysis layer, and the shared quota.
AI Writing Assistant
Standard vs Expert mode, credit costs, and the reserve/commit flow.
Billing & Credits
Entitlements, the credit ledger, plans, passes, and top-up packs.
Architecture
System Overview
Local-first storage, the optional cloud layer, and the full technology stack.
Monorepo
The six applications, the shared UI package, and the private template submodule.
State Management
Zustand stores, localStorage persistence, and the background sync engine.
Export Pipeline
The dual-engine template model and the six client-side export formats.
Authentication
Better-Auth, email OTP, OAuth providers, and cross-subdomain sessions.
Database Schema
The Prisma data model: documents, billing, credits, portfolios, and growth programs.
Resume Schema
TypeScript definitions for ResumeData and MasterProfileData.
Design System
The @veriworkly/ui package, theme tokens, and component inventory.
Technical Reference
API Reference
OpenAPI specification for the VeriWorkly backend services.
API Keys
Creating, scoping, rotating, and revoking programmatic access keys.
Environment Variables
Every configuration key across the backend and the frontend applications.
Service Status
Health endpoints, container diagnostics, and common failure modes.
API Key Security Runbook
Rotation schedules, incident response, and release-time key checks.
Contributing
Issue claiming, branch naming, PR conventions, and coding standards.
Compliance
Privacy policy, terms of service, security policy, and licensing.
Philosophy
- Local-first, not login-first. Documents are written to the browser first. Cloud sync is opt-in.
- Ownership over lock-in. Every document exports to six formats, including raw JSON.
- Transparent AI. Cost and mode are shown before generation; generated text never overwrites your work without an explicit action.
- Open source. The application code is MIT-licensed and publicly readable.
Support
- GitHub: Open an issue or discussion on the official repository.
- Email: [email protected].
- Security: Report vulnerabilities per the Security Policy.