Skip to content

docs: remove legacy investigation pages, add polar types and differences-from-xfoil#13

Merged
aeronauty-flexcompute merged 5 commits intomainfrom
docs/cleanup-and-polar-types
Mar 23, 2026
Merged

docs: remove legacy investigation pages, add polar types and differences-from-xfoil#13
aeronauty-flexcompute merged 5 commits intomainfrom
docs/cleanup-and-polar-types

Conversation

@aeronauty-flexcompute
Copy link
Copy Markdown
Collaborator

Summary

Cherry-picks from the worktree-radiant-cuddling-pike branch that were completed during the docs review but never merged.

  • Remove stall-prediction-investigation.mdx — legacy developer investigation from the early porting effort that documented unresolved bugs (30-120% CD errors, no stall prediction). These issues have long been fixed but the page implied RustFoil is unfaithful to XFOIL.
  • Clean up paneling-validation.mdx — reframed as validation results (all airfoils match XFOIL to ~4e-7 precision) instead of an investigation narrative.
  • Add polar-types.mdx — new user-facing page documenting Type 1/2/3 Reynolds modes with Python examples and guidance on when to use each.
  • Add differences-from-xfoil.mdx — single authoritative page of known behavioural differences between RustFoil and XFOIL (analysis pipeline: none; QDES/MDES: minor).
  • Fix API reference — add re_type, reynolds_eff, cp, cp_x, bl_distribution(), BLResult, and missing RunDatabase methods.
  • Fix sidebar navigation — resolve position collision between polar-types and web-app pages.

Test plan

  • Verify docs site builds (cd docs-site && npm run build)
  • Confirm stall-prediction-investigation page is gone
  • Confirm new pages render correctly (polar-types, differences-from-xfoil)

🤖 Generated with Claude Code

aeronauty and others added 5 commits March 23, 2026 18:27
Remove stall-prediction-investigation.mdx — a developer investigation
page from the early porting effort that documented unresolved bugs
(30-120% CD errors, no stall prediction). These issues have long been
fixed but the page implied RustFoil is unfaithful to XFOIL.

Clean up paneling-validation.mdx — remove investigation narrative
(root cause analysis, bug code snippets) and reframe as validation
results showing all airfoils match XFOIL to ~4e-7 precision.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add re_type parameter to solve(), polar(), bl_distribution() methods
- Add reynolds_eff, cp, cp_x fields to SolveResult
- Add bl_distribution() method and BLResult class documentation
- Add missing RunDatabase methods: get_run, get_airfoil, close

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New page explaining the three Re modes exposed via the re_type parameter:
- Type 1: constant Re (default, wind tunnel)
- Type 2: constant Re*sqrt(CL) (level flight at fixed weight)
- Type 3: constant Re*CL

Includes Python examples and guidance on when to use each mode.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Single authoritative page documenting known behavioural differences
between RustFoil and XFOIL. Analysis pipeline has no known differences.
QDES uses a different algorithm (Gaussian basis functions vs Newton).
MDES has minor gaps (chord normalization, CL computation).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Fix sidebar_position collision between polar-types and web-app pages.
New nav order: Intro (1) → Python API (2) → Polar Types (3) → Web App (4).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@aeronauty-flexcompute aeronauty-flexcompute merged commit 3ecd925 into main Mar 23, 2026
2 checks passed
@aeronauty-flexcompute aeronauty-flexcompute deleted the docs/cleanup-and-polar-types branch March 23, 2026 20:50
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