Sync README and docs index with current solver set and repo URLs - #204
Open
shaia wants to merge 1 commit into
Open
Sync README and docs index with current solver set and repo URLs#204shaia wants to merge 1 commit into
shaia wants to merge 1 commit into
Conversation
The feature lists had drifted behind the code: RK4, PCG, GMRES(m) and multigrid all landed without the docs following, and the test count was understating the suite by nearly half. The docs index still carried the template's placeholder GitHub URLs and email, which sent readers nowhere. Also ignore build-avx2/ so the AVX2-only build tree stops showing up as untracked work.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation hygiene — no code changes. Split off from
omp-jacobi-bicgstab-solvers, where these edits were sitting uncommitted and unrelated to that branch's topic.What changed
README.mdlib/include/cfd/solvers/navier_stokes_solver.hbut was missing from the feature list).CONTRIBUTING.mdandCODE_OF_CONDUCT.mdfrom the documentation section — both files exist but were unreachable from the README.add_test()targets.docs/index.mdgithub.com/yourusername/cfdandyour.email@example.comwith the real repository URL. No placeholder strings remain in any markdown file..gitignorebuild-avx2/, an AVX2-only build tree that otherwise shows up as untracked.Verification
Each claim was checked against the tree rather than taken from the diff: RK4 symbol present, both community files present,
add_test()count, remote URL matchesgit remote -v, and a repo-wide grep confirming no placeholder URLs or emails survive.🤖 Generated with Claude Code