Improve documentation

[ildyria]

Summary by CodeRabbit

Release Notes

• Documentation

  • Expanded Docker installation guide with comprehensive deployment instructions, configuration management, and production setup examples.
  • Added Docker Compose as the recommended installation method with quick-start templates and links to official resources.

• New Features

  • Teaser displays once per day; previously shown teasers won't repeat until the next day.
  • Teaser can now be dismissed using the Escape key.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for Docker deployment expanded into a comprehensive guide covering Version 7 FrankenPHP architecture, configuration, worker scaling, and troubleshooting. Installation guide updated to recommend Docker Compose as the primary method. Homepage teaser implementation enhanced with daily visibility state management and keyboard dismissal controls.

Changes

Cohort / File(s)	Summary
Docker Documentation Expansion docs/docker.md, docs/installation.md	docker.md comprehensively reworked from basic image reference to full deployment and operations manual covering FrankenPHP-based Version 7, Docker Compose setup, configuration management, worker mode scaling, production examples, security, and troubleshooting. installation.md adds new subsection designating Docker Compose as recommended installation method with references to templates and guides.
Homepage Teaser Enhancement src/pages/index.astro	Implements daily-visibility state guard using localStorage to prevent repeated teaser displays within same calendar day, and adds global Escape key handler for teaser dismissal with listener cleanup.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Poem

🐰 Hops of joy for Docker's tale,
Where compose and workers never fail!
FrankenPHP strides so grand,
While teasers dance at Escape's command—
A rabbit's smile, from code to scrolls! 🎉

Pre-merge checks

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between adb823b and 5efe601.

📒 Files selected for processing (3)

• docs/docker.md
• docs/installation.md
• src/pages/index.astro

🧰 Additional context used

🪛 LanguageTool

docs/docker.md

[grammar] ~8-~8: Ensure spelling is correct
Context: ...: - Boot time reduced from 40-60ms to 4-6ms per request - 3-4x better throughput - ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

---

[uncategorized] ~19-~19: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rankenPHP * edge: Current development/bleeding edge builds using FrankenPHP * legacy: Lat...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~461-~461: Ensure spelling is correct
Context: ...r Version 6: - Faster boot times: 4-6ms vs 40-60ms per request - **Better throu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (6)

docs/installation.md (1)

3-11: LGTM! Clear and helpful addition.

The new "Recommended Installation Method" section provides clear guidance and aligns well with the expanded Docker documentation in this PR. The links to the official template and documentation are appropriate.

src/pages/index.astro (2)

261-270: LGTM! Well-implemented daily visibility guard.

The localStorage-based daily visibility check is clean and effective. Using toDateString() for date comparison ensures the teaser appears once per calendar day.

---

321-328: LGTM! Good accessibility improvement.

The Escape key handler provides a keyboard-friendly dismissal option, and properly cleans up the event listener to prevent memory leaks. The TypeScript type annotation is valid since Astro v5 processes inline scripts as TypeScript by default.

docs/docker.md (3)

1-132: LGTM! Comprehensive and well-structured documentation.

The expanded Docker documentation provides excellent coverage of the Version 7 FrankenPHP architecture, volume mounts, and configuration. The quick start examples are clear and the distinction between v7 and legacy setups is well explained.

---

175-281: LGTM! Excellent worker mode documentation.

The worker mode section clearly explains horizontal scaling setup with critical requirements highlighted (lines 246-249). Both scaling options are well documented and the examples are production-ready.

---

319-583: LGTM! Thorough operational guidance.

The configuration management, upgrading, troubleshooting, and security sections provide comprehensive operational guidance. The production example is complete and follows Docker best practices with secrets, networks, and proper service dependencies.