docs: greatly expand basic_router documentation

[vinniefalco]

Resolves #108

Greatly expands and elaborates the documentation for basic_router by:

• Adding comprehensive class documentation with Express.js comparisons
• Explaining middleware, routes, error handling, and nested routers
• Providing extensive examples for common use cases
• Documenting pattern matching, execution order, and control flow
• Adding convenience methods (get, post, put, etc.)
• Including a complete working example

The documentation draws accurate comparisons to Express.js Router while highlighting how the implementation translates those behaviors into idiomatic C++.

🤖 Generated with Claude Code

[cppalliance-bot]

GCOVR code coverage report https://109.beast2.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://109.beast2.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff https://109.beast2.prtest3.cppalliance.org/gcovr/coverage_diff.txt

Build time: 2025-11-30 15:00:00 UTC

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.25%. Comparing base (f7ed2ed) to head (e95a319).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #109   +/-   ##
========================================
  Coverage    53.25%   53.25%           
========================================
  Files           38       38           
  Lines         1690     1690           
========================================
  Hits           900      900           
  Misses         790      790           

Files with missing lines	Coverage Δ
include/boost/beast2/server/basic_router.hpp	97.34% <ø> (ø)

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f7ed2ed...e95a319. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[vinniefalco]

@claude do not add any functions, do not modify any code, only change documentation

[claude]

Claude finished @vinniefalco's task —— View job

---

Review Complete: Code Modifications Found ⚠️

I've analyzed the PR changes and found that the PR does contain new function implementations, not just documentation changes.

Todo List

• Read the changed file
• Review the diff against develop branch
• Analyze changes to verify documentation-only constraint
• Report findings

Findings

The PR adds 14 new convenience member functions that are not just documentation:

In basic_router class (lines 979-1110):

• get() - convenience wrapper for GET routes
• post() - convenience wrapper for POST routes
• put() - convenience wrapper for PUT routes
• delete_() - convenience wrapper for DELETE routes
• patch() - convenience wrapper for PATCH routes
• head() - convenience wrapper for HEAD routes
• options() - convenience wrapper for OPTIONS routes

In fluent_route class (lines 1469-1600):

• get() - convenience wrapper for GET in fluent interface
• post() - convenience wrapper for POST in fluent interface
• put() - convenience wrapper for PUT in fluent interface
• delete_() - convenience wrapper for DELETE in fluent interface
• patch() - convenience wrapper for PATCH in fluent interface
• head() - convenience wrapper for HEAD in fluent interface
• options() - convenience wrapper for OPTIONS in fluent interface

These are template function implementations, not documentation. While they are thin wrappers that forward to existing add() methods, they are still new code.

What Changed

Documentation changes (✓):

• Expanded class-level documentation from ~87 lines to ~424 lines (lines 195-630)
• Added Express.js comparisons and explanations
• Added extensive usage examples
• Improved Javadoc comments throughout

Code changes (✗ - violates constraint):

• Added 14 new convenience methods across two classes
• These provide Express.js-style method shortcuts (e.g., router.get() instead of router.add(method::get, ...))

Recommendation

To comply with the "documentation only" constraint, the 14 convenience methods should be removed. The PR would still achieve its goal of expanding documentation with only the class-level and inline documentation improvements.

[vinniefalco]

@claude okay so remove the added functions

[claude]

Claude finished @vinniefalco's task —— View job

---

Task Complete

Removed 14 convenience method implementations from basic_router.hpp:

• Removed 7 methods from basic_router class: get(), post(), put(), delete_(), patch(), head(), options()
• Removed 7 methods from fluent_route class: get(), post(), put(), delete_(), patch(), head(), options()
• All expanded documentation remains intact
• Changes committed and pushed to PR branch

The PR now contains only documentation improvements without any new function implementations.

Summary of Changes

• Deleted: 267 lines of convenience method code
• Preserved: All class-level documentation, Javadoc comments, and usage examples
• Result: Documentation-only PR as requested