Skip to content

docs: update documentation and requirements.#2193

Closed
7ui77 wants to merge 11 commits into
lnreader:masterfrom
7ui77:update-docs-v3
Closed

docs: update documentation and requirements.#2193
7ui77 wants to merge 11 commits into
lnreader:masterfrom
7ui77:update-docs-v3

Conversation

@7ui77

@7ui77 7ui77 commented May 16, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates the documentation and environment requirements.

Changes:

  • Node.js Requirement: Updated to >= 22 in README.md, docs/quickstart.md, and package.json's engines field. (Vite 6 and Tailwind v4 require modern Node.js features like zstd support, especially on ARM).
  • API Consistency:
    • Renamed parseNovelAndChapters to parseNovel in docs.md.
    • Replaced url with path in NovelItem, SourceNovel, and parseChapter to reflect the current relative path design.
  • Data Formatting:
    • Documented releaseTime format as YYYY-MM-DD (using dayjs).
    • Ensured status uses NovelStatus in examples.
  • Tutorial Updates: Updated website-tutorial.md to consistently refer to path instead of URL.

These updates provide accurate guidance for developers building plugins for the version 3 ecosystem.

rajarsheechatterjee and others added 8 commits April 8, 2023 18:39
- Update README and Quickstart to require Node.js >= 22
- Update docs.md: rename parseNovelAndChapters to parseNovel
- Update docs.md: use path instead of url for v3 structure
- Update docs.md: specify releaseTime format (dayjs YYYY-MM-DD)
- Update docs.md: ensure status uses NovelStatus
- Update website-tutorial.md to reflect path usage
- Add engines requirement to package.json
@7ui77 7ui77 closed this May 16, 2026
@7ui77 7ui77 reopened this May 16, 2026
@7ui77 7ui77 marked this pull request as draft May 16, 2026 03:57
@7ui77

7ui77 commented May 16, 2026

Copy link
Copy Markdown
Contributor Author

Updated documentation and constants with correct icon paths and default cover URL.

  • Corrected icon path in docs/quickstart.md and docs/docs.md to point to public/static/src.
  • Updated defaultCover in src/types/constants.ts to use the correct GitHub raw URL.

@7ui77 7ui77 marked this pull request as ready for review May 16, 2026 07:31
@7ui77 7ui77 changed the title docs: update documentation and requirements for v3.0.0 docs: update documentation and requirements. May 16, 2026
@7ui77 7ui77 marked this pull request as draft May 16, 2026 08:41
@7ui77 7ui77 closed this May 16, 2026
@7ui77 7ui77 deleted the update-docs-v3 branch May 17, 2026 02:11
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.

2 participants