Add docs for top user-question gaps (Pipeline API, Modes, Telegram, platforms, custom CSS, uninstall)#118
Open
Frooodle wants to merge 19 commits into
Open
Add docs for top user-question gaps (Pipeline API, Modes, Telegram, platforms, custom CSS, uninstall)#118Frooodle wants to merge 19 commits into
Frooodle wants to merge 19 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…, Proxmox helper)
…ferings for details
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 (alltelegram.*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 likesplit-pageswhen the API requires full paths like/api/v1/general/split-pages), added complete operation reference for allgeneral/misc/security/convert/filternamespaces, parameter schemas for the common operations, and a newPOST /api/v1/pipeline/handleDataREST 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:dpkg -rcommandsTest plan
npm run buildsucceeds (Docusaurus build)