docs: centralize project documentation into root README

[addee1]

Closes #37

📄 Documentation Consolidation

This PR centralizes all project documentation into a single root README.md.

Changes

• Merged filter and plugin documentation into the root README
• Removed package-level README files:
  • src/main/java/org/juv25d/filter/README.md
  • src/main/java/org/juv25d/plugin/README.md
• Added clear references to:
  • docs/adr/
  • docs/notes/

Why

• Improves discoverability of documentation
• Makes onboarding easier for new contributors
• Reduces duplication and scattered documentation
• Keeps architectural documentation in /docs while providing overview in root README

Summary by CodeRabbit

Release Notes

• Documentation
  • Restructured project documentation with expanded content on architecture overview, request lifecycle, and core components
  • Enhanced running and development instructions, including Docker-based and IDE-based approaches
  • Consolidated component documentation for improved organization and unified guidance

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation consolidation: the main README.md is expanded with comprehensive architecture, lifecycle, and configuration details for a Java HTTP server project. Concurrently, filter and plugin module-specific README files are removed, consolidating their content into the primary documentation.

Changes

Cohort / File(s)	Summary
Documentation Consolidation README.md	Comprehensive rework from simple Java introduction to full HTTP server project documentation. Added architecture overview, request lifecycle, core components (Server, ConnectionHandler, Pipeline, Filters, Plugin, HttpParser, HttpResponseWriter), Docker setup, development guidance, static file serving, and code examples for filters and plugins.
Removed Module-Specific Docs src/main/java/org/juv25d/filter/README.md, src/main/java/org/juv25d/plugin/README.md	Deleted filter and plugin documentation files; content consolidated into main README.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

• feature/FilterPlugin #17: Introduced Filter, FilterChain, Pipeline, and Plugin architecture components — this PR consolidates the documentation for those same architectural elements.

Suggested reviewers

• VonAdamo
• kristina0x7

Poem

🐰 A rabbit reorganized the warren's maps,
Gathering wisdom in one grand tome,
No scattered notes in distant traps—
Just one clear guide to call our home,
Architecture, filters, plugins aligned,
All knowledge organized, perfectly designed! 📚✨

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title clearly and concisely summarizes the main change: centralizing project documentation into the root README.
Linked Issues check	✅ Passed	The PR successfully addresses issue #37 by consolidating scattered documentation into a single root README and removing package-level README files.
Out of Scope Changes check	✅ Passed	All changes directly align with the stated objective of centralizing documentation; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/centralize-readme-

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

README.md (3)

39-55: Add language identifiers to fenced code blocks.

markdownlint MD040 flags multiple fences without language; add text, bash, java, or yaml as appropriate to improve rendering and tooling.

✅ Suggested edits (sample)

-```
+```text
 Client
   ↓
 ServerSocket
@@
-```
+```text
 http://localhost:3000

-```
+```text
 org.juv25d.App

-```
+```text
 src/main/resources/static/

-```
+```text
 Client → Filter 1 → Filter 2 → ... → Plugin → Response → Client

-```
+```text
 application-properties.yml

-```
+```text
 docs/adr/

-```
+```text
 docs/adr/README.md

-```
+```text
 docs/notes/

Also applies to: 141-143, 156-158, 162-164, 174-176, 269-271, 322-324, 364-366, 370-372, 386-388

---

178-186: Fix heading level jumps (MD001).

Headings skip a level (h2 → h3). Align these sections to the proper hierarchy for consistent structure.

✅ Suggested edits

-### Example Mapping
+## Example Mapping

-### Supported Patterns
+## Supported Patterns

Also applies to: 251-256

---

77-85: Hyphenate compound adjective for clarity.

“Rate limiting” reads like a compound adjective here; “Rate-limiting” is clearer.

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

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.}

[simonforsberg]

Nicely done! 📝