Skip to content

docs: migrate wiki to mkdocs, retire wiki references#25

Merged
EshwarCVS merged 1 commit intomasterfrom
claude/migrate-wiki-mkdocs-MtP5x
Apr 18, 2026
Merged

docs: migrate wiki to mkdocs, retire wiki references#25
EshwarCVS merged 1 commit intomasterfrom
claude/migrate-wiki-mkdocs-MtP5x

Conversation

@EshwarCVS
Copy link
Copy Markdown
Collaborator

@EshwarCVS EshwarCVS commented Apr 18, 2026

Summary

All documentation now lives in docs/ (mkdocs). The GitHub wiki is redundant — its content was fully migrated to the 45-page mkdocs site in PR #21. This PR retires the remaining wiki reference in the repo.

Changes

  • .github/pull_request_template.md — replace wiki with docs/ in the PR checklist item

Why

The GitHub wiki was set up early in the project. PR #21 performed a full gap analysis and migrated all content into the versioned mkdocs site (Tutorial, Advanced Guide, Security, Databases, Deployment, Concepts, How-To, FAQ — 45 pages total). The wiki is now redundant and the PR template was the last reference to it.

Checklist

  • Tests pass locally (pytest --cov=FasterAPI)
  • Benchmarks not regressed
  • docs/ updated if user-facing behavior changed (this IS the docs update)

All documentation now lives in docs/ (mkdocs). The GitHub wiki is
redundant — its content was fully migrated to the 45-page mkdocs site
in PR #21. Update the PR template checklist to point to docs/ instead
of the wiki.

https://claude.ai/code/session_01ApiN484RaqQrQNgLRQgvrt
@github-actions
Copy link
Copy Markdown
Contributor

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.

🟢 Benchmark status: improvement detected.

HTTP throughput (FasterAPI vs FastAPI vs Fiber)

Endpoint FasterAPI FastAPI Fiber (Go) F / Fast
GET /health 595/s 617/s 602/s 0.96x
GET /users/{id} 640/s 670/s 652/s 0.95x
POST /users 539/s 597/s 581/s 0.90x

Direct ASGI (no HTTP; 50,000 iterations)

Endpoint FasterAPI FastAPI Speedup vs README ASGI ratio
GET /health 202,179/s 22,063/s 9.16x +33.8%
GET /users/{id} 185,820/s 15,610/s 11.90x +36.4%
POST /users 116,545/s 13,035/s 8.94x +25.0%

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

Router Ops/s Speedup vs README
Radix 969,617 8.6x +12.8%
Regex 113,138 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.

@EshwarCVS EshwarCVS merged commit 5907ab3 into master Apr 18, 2026
6 checks passed
@EshwarCVS EshwarCVS deleted the claude/migrate-wiki-mkdocs-MtP5x branch April 18, 2026 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants