docs: add GitHub Pages documentation with Documenter.jl

[mgyoo86]

PR: Add GitHub Pages Documentation with Documenter.jl

Summary

• Set up GitHub Pages documentation using Documenter.jl with automatic CI deployment
• Restructure documentation into a 4-stage learning journey: Basics → Advanced → Features → Reference → Architecture
• Add comprehensive English design documents
• Improve technical accuracy of memory semantics documentation

Key Changes

Infrastructure

File	Description
.github/workflows/Documentation.yml	CI workflow for automatic docs deployment
docs/Project.toml	Documenter.jl dependencies
docs/make.jl	Build script with README path rewriting

Documentation Structure

docs/src/
├── index.md                    # Generated from README.md
├── basics/                     # Getting started
│   ├── quick-start.md
│   ├── with-pool-patterns.md
│   ├── api-essentials.md
│   └── safety-rules.md
├── advanced/                   # Advanced patterns (NEW)
│   └── pool-patterns.md
├── features/                   # Optional features
│   ├── maybe-with-pool.md
│   ├── cuda-support.md
│   └── configuration.md
├── reference/                  # Complete API
│   └── api.md
└── architecture/               # Internal design
    ├── how-it-works.md
    ├── type-dispatch.md
    ├── macro-internals.md
    └── design-docs.md

Design Documents (English)

Document	Topic
hybrid_api_design.md	acquire! vs unsafe_acquire! type stability analysis
nd_array_approach_comparison.md	N-way set-associative cache design
untracked_acquire_design.md	Macro-based detection and 1-based sentinel pattern
fixed_slots_codegen_design.md	Zero-allocation iteration via @generated
cuda_extension_design.md	CUDA backend architecture

Technical Accuracy Improvements

Memory semantics clarification:

• Changed "recycled" → "marked available for reuse" throughout docs
• Added !!! warning admonition explaining undefined behavior:
  • Subsequent acquire! calls may overwrite data
  • Task termination may trigger GC
  • Silent data corruption is the worst case

unsafe_acquire! clarification:

• Explicitly states zero-allocation on cache hit
• Added !!! tip showing cache behavior (0 bytes hit / 80-144 bytes miss)
• Links to N-Way Cache architecture documentation

New advanced patterns:

• Direct pool access via get_task_local_pool() in inner functions
• Memory flow visualization with ASCII diagrams
• User responsibility warnings for leak prevention

Commits

b7cb5bf docs: improve technical accuracy and add advanced pool patterns
6c13552 docs: restructure to 4-stage learning journey
d807d05 refactor: move docs to docs/src/, update README links to GitHub Pages
5049263 docs: update Further Reading with GitHub links and English descriptions
27ef39a docs: update design documents to match current codebase
7384f84 docs: merge hybrid API design docs into single file
e984134 docs: add English design documents to docs/design
5de5de3 docs: add GitHub Pages documentation with Documenter.jl

Test Plan

• julia --project=docs docs/make.jl builds successfully
• All cross-references resolve correctly
• Admonitions (!!! warning, !!! tip) render properly
• Verify deployment on GitHub Pages after merge

Breaking Changes

None. This PR only adds documentation infrastructure.

Related

• Closes documentation setup for GitHub Pages
• Prepares for future doc improvements and API documentation

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.41%. Comparing base (fa1bf81) to head (b7cb5bf).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #12   +/-   ##
=======================================
  Coverage   96.41%   96.41%           
=======================================
  Files           8        8           
  Lines        1004     1004           
=======================================
  Hits          968      968           
  Misses         36       36           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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