Skip to content

docs: reference section and subfolder READMEs - #13

Merged
Filettus-newkeyboard merged 1 commit into
feat/validation-fallbackfrom
docs/subfolder-readmes
Sep 23, 2026
Merged

Filettus-newkeyboard merged 1 commit into
feat/validation-fallbackfrom
docs/subfolder-readmes

Conversation

@PSamuele

Copy link
Copy Markdown
Contributor

What

  • Main README: new "Reference" section with every symbol, terminal message, table column, score formula, validation mark, value (with where it is used and why) and condition. Values that come from the original code and were never tuned are marked as such.
  • Subfolder READMEs rewritten to match the code. Removed statements that were not true: "No External Dependencies", "sub-millimeter refinement", automatic install "without prompting", "legacy code", exported "XFOIL polars".
  • Each subfolder README links to the Reference section.
  • Roadmap: "One shared core package" removed (done in refactor: shared naca_core package #5).

All numbers quoted come from the runs documented in the previous PRs.

Depends on

#12 (base branch: feat/validation-fallback).

@Filettus-newkeyboard
Filettus-newkeyboard merged commit a23d705 into feat/validation-fallback Sep 23, 2026
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