Official documentation for VeriWorkly, an open-source, local-first resume builder.

VeriWorkly Documentation

VeriWorkly is a professional, open-source platform designed for resume creation, career data management, and high-fidelity document exporting. This documentation provides comprehensive resources for users building their resumes and developers contributing to the ecosystem.

Machine-Readable Index

A machine-readable summary of this documentation is available at: https://docs.veriworkly.com/llms.txt.

Core Capabilities

VeriWorkly is engineered to provide a seamless and secure experience for managing professional identities.

Quick Start

Initial steps for deploying or developing with the VeriWorkly platform.

System Overview

A high-level analysis of the VeriWorkly architecture and data flow.

Architecture

Deep-dives into the monorepo structure, state management, and rendering engine.

Resume Schema

Technical reference for the Master Profile and resume data structures.

User Guides

Step-by-step instructions for building, customizing, and exporting resumes.

Technical Reference

For advanced users and developers looking to integrate with or contribute to the platform.

API Reference

Complete OpenAPI specification for the VeriWorkly backend services.

Environment Variables

Comprehensive reference for all configuration options across the ecosystem.

Contributing

Standards and protocols for participating in the open-source community.

Compliance

Privacy policies, terms of service, and security standards.

Philosophy

VeriWorkly is built on the principle that professional data should respect user privacy by default. The platform is:

Local-First: Data remains in the user's browser until explicit synchronization is initiated.
Open-Source: Transparent code distributed under the MIT license.
ATS-Optimized: High-fidelity document exports designed for modern recruitment systems.

Support

If you encounter issues or have technical inquiries:

GitHub: Open an issue or discussion on the official repository.
Email: Contact the development team at [email protected].

Documentation