Skip to content

docs(readme): clarify migration language in README#382

Merged
zachyale merged 1 commit into
developfrom
docs/update-readme
Apr 4, 2026
Merged

docs(readme): clarify migration language in README#382
zachyale merged 1 commit into
developfrom
docs/update-readme

Conversation

@zachyale

@zachyale zachyale commented Apr 4, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

Updates the README migration note for existing Booklore users to make the upgrade path clearer and reduce ambiguity around the project's relationship.

Changes

  • Modified the project description to reduce ambiguity around succession/the relationship to Booklore
  • Modified the migration instructions for ambiguity

Summary by CodeRabbit

  • Documentation
    • Updated project positioning to clarify the project's independent status as a community fork
    • Improved Docker migration guidance for users transitioning from Booklore installations

@coderabbitai

coderabbitai Bot commented Apr 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14744cb8-019b-4893-9a67-c15c6907b0cb

📥 Commits

Reviewing files that changed from the base of the PR and between 36005e5 and a5ff7b9.

📒 Files selected for processing (1)
  • README.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Test Suite / Frontend Tests
  • GitHub Check: Test Suite / Backend Tests
  • GitHub Check: Analyze (java-kotlin)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2026-04-02T09:25:37.417Z 
Learnt from: balazs-szucs
Repo: grimmory-tools/grimmory PR: 334
File: booklore-api/src/main/java/org/booklore/service/reader/EpubReaderService.java:402-407
Timestamp: 2026-04-02T09:25:37.417Z
Learning: In grimmory-tools/grimmory, before commenting on any file processing code (epub or pdf), always verify the current state of the relevant upstream grimmory libraries: `grimmory-tools/epub4j` (for epub) and `grimmory-tools/PDFium4j` (for pdf). These custom libraries may have different APIs, capabilities, and limitations compared to the third-party libraries they replace. Issues about streaming, buffering, or API surface may need to be filed/addressed in those upstream repos rather than in grimmory itself.

Applied to files:

  • README.md
📚 Learning: 2026-04-02T09:25:37.417Z 
Learnt from: balazs-szucs
Repo: grimmory-tools/grimmory PR: 334
File: booklore-api/src/main/java/org/booklore/service/reader/EpubReaderService.java:402-407
Timestamp: 2026-04-02T09:25:37.417Z
Learning: In grimmory-tools/grimmory, epub processing uses `org.grimmory.epub4j` from https://github.com/grimmory-tools/epub4j. This is a grimmory-maintained fork and is fundamentally different from `io.documentnode.epub4j`. Do NOT generalize API knowledge, behavior, or limitations of `io.documentnode.epub4j` to the grimmory fork. Before raising review comments on epub-related file processing code, verify the current API and capabilities in the grimmory-tools/epub4j repository.

Applied to files:

  • README.md
🔀 Multi-repo context grimmory-tools/grimmory-docs

grimmory-tools/grimmory-docs

  • README.md exists and is docs-only; repo is the docs site for Grimmory. [::grimmory-tools/grimmory-docs::README.md]
  • UI copy referencing Booklore / project status:
    • src/pages/HomepageHeader.tsx:24 — project status line states Booklore origin and "work in progress" wording. This is another place where messaging about relationship to Booklore appears and may need parallel wording changes. [::grimmory-tools/grimmory-docs::src/pages/HomepageHeader.tsx:24]
  • Docker/migration guidance present in docs:
    • docs/testing/testing-setup.md: steps describing copying .env and docker-compose.yml and "Modify docker-compose.yml" — contains migration/upgrade instructions that could overlap with README migration language. [::grimmory-tools/grimmory-docs::docs/testing/testing-setup.md]
    • docs/installation.md, docs/getting-started.md, docs/getting-started.md and docs/library/setup-first-library.md — include Docker Compose usage and examples; any change to README migration wording may warrant checking these for consistency. [::grimmory-tools/grimmory-docs::docs/installation.md][::grimmory-tools/grimmory-docs::docs/getting-started.md][::grimmory-tools/grimmory-docs::docs/library/setup-first-library.md]
  • Metadata note referencing Booklore:
    • docs/metadata/sidecar-files.md:20 — contains a "generatedBy": "booklore" sidecar example; consider whether copy should be updated or clarified for forks. [::grimmory-tools/grimmory-docs::docs/metadata/sidecar-files.md:20]

Conclusion: The PR edits to README are documentation-only, but related docs and UI copy in this repository reference Booklore or contain Docker migration guidance that should be reviewed for consistent messaging. No code/API breaking changes found.

🔇 Additional comments (2)
README.md (2)

2-2: Clear project-positioning update.

This phrasing removes ambiguity and aligns with the PR objective to describe Grimmory’s relationship to Booklore more precisely.

93-93: Migration guidance is now concrete and less ambiguous.

Good clarification of what users can keep unchanged during Booklore → Grimmory image migration while keeping the required action explicit.

📝 Walkthrough

Walkthrough

README.md documentation updates clarifying the project status as an independent community fork of Booklore and refining Docker migration guidance to explain which configuration elements can remain unchanged during container image transitions.

Changes

Cohort / File(s) Summary
Documentation
README.md		 Updated project status statement removing "early development" framing and recharacterizing the project as an independent community fork; clarified Docker migration guidance to allow retention of service name, container name, database configuration, ports, and volumes while updating only the image: line.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

chore

Poem

A fork stands tall, independent and free,
No longer in shadow—for all eyes to see!
Docker migrations made clearer today,
The path forward brightens in every way! 🐰✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title follows the conventional commit format with 'docs' type and a clear, descriptive subject about clarifying migration language in the README.
Description check ✅ Passed The description includes required sections (Description and Changes) but lacks the 'Linked Issue' section that is specified in the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-readme
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/update-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot added the chore label Apr 4, 2026
@zachyale zachyale merged commit be36d50 into develop Apr 4, 2026
14 checks passed
@zachyale zachyale deleted the docs/update-readme branch April 4, 2026 21:07
@coderabbitai coderabbitai Bot mentioned this pull request Apr 8, 2026
Closed
1 task
zachyale added a commit to zachyale/grimmory that referenced this pull request Apr 17, 2026
@zachyale
docs(readme): modify wording on project independence (grimmory-tools#382
fe751d0 
)
zachyale added a commit to zachyale/grimmory that referenced this pull request Apr 17, 2026
@zachyale
docs(readme): modify wording on project independence (grimmory-tools#382
c38440f 
)
zachyale added a commit that referenced this pull request Apr 17, 2026
@zachyale
docs(readme): modify wording on project independence (#382)
60f9276
zachyale added a commit that referenced this pull request Apr 22, 2026
@zachyale
docs(readme): modify wording on project independence (#382)
e172fa8
@coderabbitai coderabbitai Bot mentioned this pull request Apr 30, 2026
Open
dsmouse pushed a commit to dsmouse/grimmory that referenced this pull request May 11, 2026
@zachyale
docs(readme): modify wording on project independence (grimmory-tools#382
1cf4a93 
)
This was referenced May 13, 2026
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@balazs-szucs balazs-szucs balazs-szucs approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

chore

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@zachyale @balazs-szucs