docs: Fix Documentation Accuracy, Dead Links, and Grammar in Docs - #2402
Merged
Conversation
rajarsheechatterjee
commented
Aug 9, 2026
Member
- Correct API docs against actual src/types/plugin.ts and libs/*: fix FilterToValues type name, add missing PluginBase fields (customJS, customCSS, webStorageUtilized, resolveUrl), add missing SourceNovel.rating and ChapterItem.scanlator fields, fix ExcludableCheckboxGroupValue's include/exclude keys, document the NovelStatus enum
- Fill in the previously-empty "Using Cheerio" and "Custom fetching functions" sections, and add a new "Other libraries" section (isUrlAbsolute, storage variants, AES helpers)
- Write real content for quickstart.md's "Creating multi-source plugins" section instead of a bare heading, and clarify the lang-folder-name mismatch between plugins/ and public/static/src/
- Fix broken/empty markdown links, mismatched TOC anchors, a duplicate anchor id, and a malformed GitHub alert callout
- Normalize all code examples to the repo's own Prettier style (2-space, single-quote)
- Fix typos, grammar, and copy-paste errors (Desciption, it's/its, duplicated parseChapter description, SesesionStorage, run-on pre-submission checklist)
- Cross-link testing.md and website-tutorial.md; add missing testing.md entry to README's docs index; add a title to komga-plugin.md
- Correct API docs against actual src/types/plugin.ts and libs/*: fix FilterToValues type name, add missing PluginBase fields (customJS, customCSS, webStorageUtilized, resolveUrl), add missing SourceNovel.rating and ChapterItem.scanlator fields, fix ExcludableCheckboxGroupValue's include/exclude keys, document the NovelStatus enum - Fill in the previously-empty "Using Cheerio" and "Custom fetching functions" sections, and add a new "Other libraries" section (isUrlAbsolute, storage variants, AES helpers) - Write real content for quickstart.md's "Creating multi-source plugins" section instead of a bare heading, and clarify the lang-folder-name mismatch between plugins/ and public/static/src/ - Fix broken/empty markdown links, mismatched TOC anchors, a duplicate anchor id, and a malformed GitHub alert callout - Normalize all code examples to the repo's own Prettier style (2-space, single-quote) - Fix typos, grammar, and copy-paste errors (Desciption, it's/its, duplicated parseChapter description, SesesionStorage, run-on pre-submission checklist) - Cross-link testing.md and website-tutorial.md; add missing testing.md entry to README's docs index; add a title to komga-plugin.md Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K19WYNGJcSdB5331FvEDEH
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.