PDF AcroForm Editor — Documentation
Welcome to the project documentation. This is a living set of documents that evolves with the codebase.
For Users
New here? Start with the tutorial.
| Document | Quadrant | Description |
|---|---|---|
| Getting Started | Tutorial | Upload your first PDF, add a field, and export — step by step |
| How to Add a New Field Type | How-to | Extending the editor to support additional AcroForm field types |
| How to Configure Naming Conventions | How-to | Set up custom field naming patterns for your PDF export |
For Developers
Working on the code? Read these.
| Document | Quadrant | Description |
|---|---|---|
| Architecture | Explanation | Why the system works the way it does — internal model vs. PDF model, adapter pattern, coordinate systems |
| Design Spec | Reference | Complete product design — data model, UI layout, interaction model, PDF integration, testing strategy |
| Data Model Reference | Reference | TypeScript interfaces, field types, project schema, JSON export format |
Review Artifacts
Product and engineering reviews that shaped this project.
| Document | Type | Description |
|---|---|---|
| CEO Review — Scope Decisions | Planning | Scope expansion review — what was accepted, deferred, and skipped for the MVP |
Quality & Operations
| Document | Quadrant | Description |
|---|---|---|
| Known Bugs | Reference | Confirmed bugs, reproduction steps, cross-references, and agent warnings |
| Analytics Events | Reference | Catalog of tracked Umami events, payloads, and privacy classification |
| Error Tracking | Reference | GlitchTip configuration, captured errors, and sanitization rules |
| Privacy Policy | Explanation | Privacy policy source text for the editor and marketing site |
Diataxis Framework
These docs follow the Diataxis framework:
- Tutorials — learning-oriented, for newcomers
- How-to guides — task-oriented, for practitioners who know the basics
- Reference — information-oriented, for lookup
- Explanation — understanding-oriented, for insight into why things work
Contributing to Docs
Docs live in docs/ as Markdown files. When you add a feature, add or update the relevant documentation in the same PR. Keep the README links current.