Skip to content

Improve user guides, model explanations and documentation search - #222

Open
rois1995 wants to merge 25 commits into
su2code:developfrom
rois1995:docs/user-guides
Open

Improve user guides, model explanations and documentation search#222
rois1995 wants to merge 25 commits into
su2code:developfrom
rois1995:docs/user-guides

Conversation

@rois1995

@rois1995 rois1995 commented Oct 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

This makes the documentation easier to navigate and brings older explanations and examples into line with the code.

  • Clarify the page roles and navigation, keeping worked cases in Tutorials and numerical comparisons in V&V.
  • Add explanations of turbulence, transition, hybrid RANS/LES and wall treatment, with links to model references.
  • Add nine setup guides, troubleshooting and version-8 migration guidance.
  • Correct outdated settings, units, model descriptions and broken links in existing pages.
  • Add search across the documentation, Tutorials and V&V, and connect the user pages to the developer guides and generated references.

The setup guides remain marked as drafts where specialist review is still needed. A status page records completed work and remaining gaps, including 24 configuration options that still lack source descriptions.

The combined build passes 18 documentation tests and checks 26,164 internal references and 179 search entries with zero findings. The website GitHub check passed the same checks and regression checks for search loading, short queries and failed index downloads. Changed sections are marked in red in the preview.

Companion SU2 PR: su2code/SU2#2992. The NACA 0021 case and DES updates are proposed separately in #223.

Combined preview — this preview follows the docs_site branches and includes the proposed NACA 0021 contribution.

rois1995 and others added 23 commits October 26, 2026 11:15
@rois1995 @claude
Replace configuration options that SU2 no longer has
9b3b978 
Rename options that were renamed in the code (KIND_SOLVER and
PHYSICAL_PROBLEM to SOLVER, KT_CONSTANT to THERMAL_CONDUCTIVITY_CONSTANT,
RAMP_ROTATING_FRAME to RAMP_MOTION_FRAME, UNST_ADJOINT_START_ITER to
UNST_ADJOINT_ITER, CFL to CFL_NUMBER, SPECIES_USE_STRONG_BC to
MARKER_SPECIES_STRONG_BC), fix the MAKER_SPECIES_STRONG_BC typo and
remove CONV_CRITERIA, which CONV_FIELD replaces.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Fix option names, values and units that disagree with the SU2 code
e8671db 
Each change was checked against SU2 develop 11c177b904: solver names,
SST default version and keywords, scalar schemes, shape_optimization.py
options, turbomachinery ramp options, INCONSISTENT_DISC, flamelet and
species options and value counts, reference temperature and contact
resistance units.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Add draft case setup guides
e573fc8 
Nine draft guides (RANS external aero, incompressible, unsteady and DES,
transition, turbomachinery, heat transfer and CHT, species and
combustion, shape optimization, non-ideal flows) in a new menu section.
Settings come from the code, tutorials and test cases; each statement
names its source, and advice that needs an expert check is marked
"to be reviewed".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Point the CHT guide to the real sections of the Multizone page
4276a61 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Add a search page and turn on the feed, SEO and sitemap plugins
8a6b2c6 
The plugins were listed but not whitelisted, so GitHub Pages skipped
them: feed.xml and sitemap.xml were missing. The old v6 docs stay
online for old links but are left out of the sitemap. The search page
uses an index of the docs, tutorials and V&V pages made at build time.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Add Changes in Version 8 and a What's New menu section
67861ca 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Use the real meson option tracy_enable on the Tracy page
0a76e22 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Point the old AD page to the new Automatic Differentiation guide
b5d5180 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Add pages per model family and update the moved TMR links
95eb8cc 
Turbulence Models, Transition Models, Hybrid RANS/LES and Wall Treatment
in a new Physical Models menu section. Physical Definition keeps short
pointers. The NASA Turbulence Modeling Resource moved to
tmbwg.github.io/turbmodels; the old links redirect to a landing page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Merge the two plugins lists of _config.yml
6468661 
The second list (jekyll-gist only) replaced the first one, so the feed,
SEO and sitemap plugins never ran and feed.xml and sitemap.xml were
missing on the website.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Show only the search icon in the top bar, so it stays on one line
4057d12 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Fix broken section and page links in old pages
dc87b31 
Table of contents links now match the real section ids, and links to
.md files now point to the page addresses.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Add a Troubleshooting page
5b6e250 
Common problems with the config, mesh, restart, divergence, convergence,
output and parallel runs: what you see, why, and what to do.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995 @claude
Docs style pass: cut repeated and empty sentences, explain unclear terms
5e04d21 
Also fixes the multigrid note in Guide-to-v8 (the damping default is now
0.5) and two statements that did not match the test cases.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
@rois1995
Correct model guidance, migration examples and complete search indexing
b0bb2fb
@rois1995
Clarify documentation roles and lock website build dependencies
4e1f1ee
@rois1995
Link documentation status from Develop and update contribution guidance
e40564d
@rois1995
Remove documentation status card from Develop
10522d1
@rois1995
docs: repair historical links and review setup and model guidance
fa67a16
@rois1995
docs: check the separate documentation and NACA0021 branches
2c6f05a
@rois1995
docs: remove whitespace warnings from the prepared changes
f5f6bdd
@rois1995
docs: check website pull requests against develop
d8838c1
@rois1995
docs: link to the published diffusion flame tutorial
27c5590
This was referenced Oct 26, 2026
Open
Open

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@rois1995