docs: rewrite plugin docs to match current app behavior - #2506
Merged
rajarsheechatterjee merged 2 commits intoSep 7, 2026
Merged
Conversation
rajarsheechatterjee
force-pushed
the
claude/lnreader-plugin-docs-audit-6fs1co
branch
from
September 7, 2026 15:48
11d5eda to
a9b6f1c
Compare
rajarsheechatterjee
changed the title
rajarsheechatterjee
changed the title
Verified docs/docs.md claims against the lnreader main app's actual plugin types and runtime (src/plugins/types/index.ts, pluginManager.ts, helpers/fetch.ts, helpers/storage.ts) and fixed drift: - Split into two explicit contracts: the plugin bundle API vs. the repository manifest/install metadata (icon -> iconUrl, customJS/ customCSS as downloaded manifest URLs, install flow). - Documented pagination (parsePage/SourcePage/totalPages), previously missing entirely. - Fixed NovelItem (missing required `id`), SourceNovel (`chapters` required, `status` is NovelStatus-only, missing `totalPages`), PluginSettings (Select/CheckboxGroup types and per-type value shapes, reload-required-for-cached-settings caveat), storage helpers (full storage API, read-only localStorage/sessionStorage), and the runtime library list (dayjs, urlencode, htmlparser2). - Filled in "Using Cheerio" and "Custom fetching functions" with real examples, fetchApi's default headers, and fetchText's silent-empty- string-on-failure behavior. - Fixed the popularNovels filter example, the Switch setting example, and the SourceNovel::path anchor link. - Added a "Getting started" section. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LoFgTFvjNVdrUbZVjdFuxf
Verified against .github/workflows/plugin-live-check.yml, scripts/live-check-plugin.js, and the playground UI (src/pages/home.tsx and friends): - testing.md: the live-check workflow posts a job/run summary (GITHUB_STEP_SUMMARY), not a PR comment. - website-tutorial.md: the playground's five tabs are actually Popular/Search/Parse Novel/Parse Chapter/Settings, not the documented Headers/Popular Novels/Search Novels/Parse Novel/Parse Chapter. There's no per-request "Headers" tab; Settings configures playground-wide fetch mode/User-Agent/cookies. Also documented two previously-unmentioned Parse Novel features: parsePage/totalPages pagination controls and the Export EPUB button. quickstart.md and komga-plugin.md were audited and found accurate; no changes made to those. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LoFgTFvjNVdrUbZVjdFuxf
rajarsheechatterjee
force-pushed
the
claude/lnreader-plugin-docs-audit-6fs1co
branch
from
September 7, 2026 16:28
8e55ebd to
f1d7476
Compare
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Checklist
(
src/plugins/types/index.ts,pluginManager.ts,helpers/fetch.ts,helpers/storage.ts)instead
type(scope): description