๐Ÿ“ฆ EqualifyEverything / equalify-docs

๐Ÿ“„ README.md ยท 42 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42# Equalify Reflow documentation

Equalify Reflow turns PDF documents into accessible markdown. These docs are grouped by what you're trying to do โ€” each page serves one purpose.

**New here?** Start with [Getting Started](getting-started) to find the path that matches you (partner, WordPress user, or developer).

## Tutorials

Guided, hands-on walkthroughs. Follow these when you're new and want to learn by doing.

- [Use the pipeline viewer](tutorials/use-the-pipeline-viewer) โ€” the fastest path: drop a PDF in the browser, watch every phase run live, inspect the output. No WordPress, no code.
- [Process your first PDF with the web app](tutorials/process-your-first-pdf-with-the-web-app) โ€” a guided end-to-end walkthrough of the hosted web app, including the PII review gate and downloading the accessible output
- [Process your first PDF with WordPress](tutorials/process-your-first-pdf-with-wordpress) โ€” install the plugin, connect it to a Reflow instance, and convert a real document end-to-end

## How-to guides

Recipes for specific tasks. Use these when you know what you want to accomplish.

- [Use the web app](how-to/use-the-web-app) โ€” day-to-day reference for the hosted web app: uploading, the pipeline viewer, the PII review phase, downloads, feedback, troubleshooting
- [Use the WordPress plugin](how-to/use-the-wordpress-plugin) โ€” day-to-day tasks: processing, managing, re-processing, multisite, troubleshooting
- [Integrate via the API](how-to/integrate-via-api) โ€” copy-pasteable recipes for submit, stream, PII approval, ledger, figures
- [Interpret the output](how-to/interpret-the-output) โ€” a reviewer's 4-minute quality scan for a converted document
- [Provide feedback](how-to/provide-feedback) โ€” how to report issues and suggest corrections

## Reference

Authoritative lookups โ€” tables, enumerations, endpoint shapes. Use when you need to check a fact.

- [API reference](reference/api) โ€” endpoints, authentication, request/response shapes
- [Supported document types](reference/supported-document-types) โ€” size limits, quality by doc type, known limitations

## Explanation

Why Reflow works the way it does โ€” concepts, tradeoffs, background. Read when you want to understand the system.

- [How it works](explanation/how-it-works) โ€” the five-stage pipeline, model choices, accessibility thesis
- [Architecture](explanation/architecture) โ€” system components, data flow, infrastructure topology

## Contributing

Reflow is open-source at [EqualifyEverything/equalify-reflow](https://github.com/EqualifyEverything/equalify-reflow) under AGPL-3.0-or-later. Development setup, testing strategy, and "how to add an agent" live in that repo โ€” see [its CONTRIBUTING.md](https://github.com/EqualifyEverything/equalify-reflow/blob/main/CONTRIBUTING.md) and [docs/](https://github.com/EqualifyEverything/equalify-reflow/tree/main/docs) directory.