docs: GitHub Pages via Actions, MkDocs and README badges

[EshwarCVS]

This PR merges integration work from stage into master.

Documentation / site

• Docs workflow deploys static site/ to GitHub Pages using the official Actions (configure → upload artifact → deploy), with .nojekyll so Jekyll does not break paths.
• Repo admins: Settings → Pages → source must be GitHub Actions (not the gh-pages branch), or the live URL can still 404.
• mkdocs.yml: site_author, use_directory_urls, theme repo icon, extra.social for GitHub + PyPI.

README

• Badges: PyPI version, GitHub release (version from tags), docs workflow pinned to master, docs site shields.io website check, GitHub Pages doc link with correct logo.

Other (already on stage)

• Ruff/mypy/CI alignment, FasterAPI.types.ASGIApp, test typing overrides, tox.ini, benchmark/compare and CONTRIBUTING tweaks as staged previously.

After merge, confirm Pages source and wait for the Docs workflow on master; live site: https://fasterapiweb.github.io/FasterAPI/

Made with Cursor

[github-actions]

Benchmark results

Ubuntu runner, Python 3.13. HTTP table uses the same httpx load against uvicorn (Python) and Fiber (Go). Direct ASGI (below) is Python-only and excludes network I/O.

HTTP throughput (FasterAPI vs FastAPI vs Fiber)

Endpoint	FasterAPI	FastAPI	Fiber (Go)	F / Fast
GET /health	498/s	502/s	500/s	0.99x
GET /users/{id}	522/s	543/s	528/s	0.96x
POST /users	475/s	480/s	439/s	0.99x

Direct ASGI (no HTTP; 50,000 iterations)

Endpoint	FasterAPI	FastAPI	Speedup	vs README ASGI ratio
GET /health	212,238/s	19,823/s	10.71x	+56.3%
GET /users/{id}	181,812/s	13,810/s	13.17x	+50.8%
POST /users	108,559/s	11,191/s	9.70x	+35.7%

Routing (radix vs regex, 1,500,000 lookups)

Router	Ops/s	Speedup	vs README
Radix	969,591	9.6x	+25.8%
Regex	101,395	1.0x

How to read this

• F / Fast = FasterAPI req/s ÷ FastAPI req/s on the same HTTP harness (higher is better).
• Fiber uses the Go app in benchmarks/fiber (same routes). Go is often several times faster than Python here; the important guard for regressions is check_regressions.py (ASGI + routing floors), which must pass in this workflow.
• vs README compares combined speedups to documented reference numbers (local machine); CI absolute req/s differs by hardware.