Repository navigation

Add developer guides and generate reference pages from the code - #2992

Open

rois1995 wants to merge 25 commits into

su2code:developfrom

rois1995:docs/developer-guides

Open

Add developer guides and generate reference pages from the code#2992
rois1995 wants to merge 25 commits into
su2code:developfrom
rois1995:docs/developer-guides

Commits on Oct 26, 2026
- Build a test SU2 website with a generated option reference and Doxygen
  
  rois1995
  and
  claude
  committed
  85884ab
- Add developer pages to the test website and build it from the website fork
  
  rois1995
  and
  claude
  committed
  7e5c0f1
- Show template text, page links and test case examples in the option reference
  
  rois1995
  and
  claude
  committed
  9490dfc
- Add "How to Add..." developer pages and make all pages easier to read
  
  rois1995
  and
  claude
  committed
  b538fdb
- Add an output fields reference, a stale page check and documentation coverage
  
  rois1995
  and
  claude
  committed
  b8722c1
- Show the changed pages in red on the test website (debug option)
  
  rois1995
  and
  claude
  committed
  05e75ca
- Also show in red the menu sections that contain changed pages
  
  rois1995
  and
  claude
  committed
  5c2e0e4
- Check the options written in config_template.cfg on the Docs Check page
  
  rois1995
  and
  claude
  committed
  65738ad
- Generate the error messages and the renamed options pages
  
  rois1995
  and
  claude
  committed
  9a78733
- Fetch the release tags from su2code/SU2 for the renamed options page
  
  rois1995
  and
  claude
  committed
  499d7dc
- List only options that a release had on the renamed options page
  
  rois1995
  and
  claude
  committed
  af228bf
- Add the AD guide, a glossary and a debugging page
  
  rois1995
  and
  claude
  committed
  bec8641
- Docs style pass: cut repeated and empty sentences, explain unclear terms
  
  rois1995
  and
  claude
  committed
  6ca0da5
- Correct documentation references and explain solver limitations
  rois1995
  committed
  658e3f1
- Build and check documentation consistently in local and CI previews
  rois1995
  committed
  293e1da
- Track documentation improvements, evidence and remaining priorities
  rois1995
  committed
  f9baca9
- Keep documentation status under Developer Docs
  rois1995
  committed
  f6f948b
- docs: correct template options and record source review
  rois1995
  committed
  d39c1ea
- docs: record the hybrid RANS/LES V&V case and model page update
  
  rois1995
  and
  claude
  committed
  e83bee8
- docs: update NACA0021 review status before contribution
  rois1995
  committed
  7e1dbf5
- docs: check the prepared PR branches without upstream deployment
  rois1995
  committed
  4bec4ab
- docs: document develop as the website PR target
  rois1995
  committed
  804c55e
- docs: format website tools with repository hooks
  rois1995
  committed
  f724d1d
- docs: address CodeQL parser and text warnings
  rois1995
  committed
  a9d05f8
- docs: correct C++ reference extraction and string defaults
  rois1995
  committed
  4990ea4

Commits

Commits on Oct 26, 2026