Add Mintlify documentation and simplify README (#24)
authorStefan Gasser <redacted>
Sun, 11 Jan 2026 10:11:54 +0000 (11:11 +0100)
committerGitHub <redacted>
Sun, 11 Jan 2026 10:11:54 +0000 (11:11 +0100)
commit4f592d6a7f4123707773236afd1551cc53f69dc9
tree7f54f3ee74d13d4f18f9be2186e34a663568be18
parentece1ffe8bee99d06cecf8cc970e9858a67765efd
Add Mintlify documentation and simplify README (#24)

* Add Mintlify documentation and simplify README

Documentation:
- Add complete Mintlify docs with introduction, quickstart, integrations
- Add concept guides: mask mode, route mode, PII detection, secrets detection
- Add API reference: chat completions, models, status, dashboard API
- Add configuration guides: overview, providers, PII, secrets, logging
- Include dashboard screenshot and branding assets

README:
- Simplify structure, move detailed docs to Mintlify
- Add centered badges and navigation links
- Add "What is PasteGuard?" section explaining problem/solution
- Update example to Dr. Sarah Chen (consistent across all docs)
- Reorder integrations (OpenAI SDK, LangChain, LlamaIndex first)
- Move Presidio attribution inline with PII section
- Add Tech Stack section

Code:
- Update description to "Privacy proxy for LLMs" in package.json,
  startup banner, and /info endpoint

Closes #21

* docs: fix secrets default to block (matches current code)
28 files changed:
README.md
config.example.yaml
docs/api-reference/chat-completions.mdx [new file with mode: 0644]
docs/api-reference/dashboard-api.mdx [new file with mode: 0644]
docs/api-reference/models.mdx [new file with mode: 0644]
docs/api-reference/status.mdx [new file with mode: 0644]
docs/concepts/mask-mode.mdx [new file with mode: 0644]
docs/concepts/pii-detection.mdx [new file with mode: 0644]
docs/concepts/route-mode.mdx [new file with mode: 0644]
docs/concepts/secrets-detection.mdx [new file with mode: 0644]
docs/configuration/logging.mdx [new file with mode: 0644]
docs/configuration/overview.mdx [new file with mode: 0644]
docs/configuration/pii-detection.mdx [new file with mode: 0644]
docs/configuration/providers.mdx [new file with mode: 0644]
docs/configuration/secrets-detection.mdx [new file with mode: 0644]
docs/favicon.svg [new file with mode: 0644]
docs/images/dashboard.png [new file with mode: 0644]
docs/integrations.mdx [new file with mode: 0644]
docs/introduction.mdx [new file with mode: 0644]
docs/logo-dark.svg [new file with mode: 0644]
docs/logo-light.svg [new file with mode: 0644]
docs/mint.json [new file with mode: 0644]
docs/quickstart.mdx [new file with mode: 0644]
docs/wordmark-dark.svg [new file with mode: 0644]
docs/wordmark-light.svg [new file with mode: 0644]
package.json
src/index.ts
src/routes/info.ts
git clone https://git.99rst.org/PROJECT