Skip to content

Add docs for top user-question gaps (Pipeline API, Modes, Telegram, platforms, custom CSS, uninstall)#118

Open
Frooodle wants to merge 19 commits into
mainfrom
claude/sleepy-lamport-f7e8b8
Open

Add docs for top user-question gaps (Pipeline API, Modes, Telegram, platforms, custom CSS, uninstall)#118
Frooodle wants to merge 19 commits into
mainfrom
claude/sleepy-lamport-f7e8b8

Conversation

@Frooodle
Copy link
Copy Markdown
Member

@Frooodle Frooodle commented Jun 1, 2026

Summary

Based on analysis of ~70 chatbot conversations from the docs.stirlingpdf.com support widget, this adds documentation for the 7 highest-priority gaps users were repeatedly hitting. Every code-driven claim was researched against Stirling-PDFNew, then re-verified with a second pass to catch inaccuracies.

New pages

  • docs/Modes-and-Licensing.md - matrix of Desktop Local / Desktop+Cloud / Desktop+self-host / Web self-host / Stirling Cloud SaaS, with credit cost table, license tier features, 5-user limit explanation, and commercial-use license breakdown.
  • docs/Configuration/Telegram Bot.md - full config schema (all telegram.* keys with env var equivalents), setup walkthrough, access control rules, debugging.
  • docs/Installation/Self-Hosting Platforms/ - Overview + per-platform guides for TrueNAS SCALE, Synology DSM, Unraid, Podman (with Quadlets), Proxmox LXC.

Expanded pages

  • docs/Configuration/Pipeline.md - fixed the previously-incorrect operation name format (users were copying short names like split-pages when the API requires full paths like /api/v1/general/split-pages), added complete operation reference for all general / misc / security / convert / filter namespaces, parameter schemas for the common operations, and a new POST /api/v1/pipeline/handleData REST API section with working curl examples.
  • docs/Configuration/UI Customisation.md - added Custom CSS injection recipe (the file-manager z-index issue users have been hitting), removed an incorrect claim about a "custom logo upload" feature that doesn't exist.
  • docs/API.md - added Integrations section pointing n8n / Zapier / Make / Power Automate users at the Pipeline endpoint.

Uninstall sections

Added per-platform Uninstalling sections to Docker, Windows, Mac, Unix, and Kubernetes install pages. Each lists exact paths (per-user data, registry/keychain entries, system-wide provisioning), the right uninstall command for each install method (MSI, winget, scoop, dpkg, dnf, brew, AUR, helm), and what data to back up first.

Why these pages

From the chatbot CSV, the bot's most-uncertain answers (Is Uncertain=True, repeated questions across multiple users, multiple languages) clustered around:

  1. Pipeline JSON / handleData - the bot kept having to say "operation names are placeholders, you must verify against your instance"
  2. n8n / external automation - 4+ questions across languages, no direct plugin so users assumed it wasn't supported
  3. Self-host platform guides - TrueNAS, Podman Quadlets, etc. all returned "knowledge sources do not contain"
  4. Modes & Licensing confusion - one user asked 4 follow-up questions about credits vs self-hosted; affects paid conversion
  5. Custom CSS injection - bot explicitly said "no documented mechanism"
  6. Telegram bot config - feature exists, bot answered from source code, but zero docs
  7. Uninstall - bot had to guess at dpkg -r commands

Test plan

  • npm run build succeeds (Docusaurus build)
  • Sidebar shows the new pages in expected locations
  • All internal cross-links resolve
  • Spot-check rendered pages in dev server for the new Self-Hosting Platforms folder
  • Confirm the rewritten Pipeline.md operation reference renders the tables cleanly
  • Validate the example curl command in the Pipeline REST API section actually works against a running instance

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
stirling-tools-github-io Ready Ready Preview, Comment Jun 2, 2026 7:21am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant