Skip to content

Cleanup the documentation - #171

Merged
MakisH merged 9 commits into
developfrom
cleanup-docs
Aug 3, 2026
Merged

Cleanup the documentation#171
MakisH merged 9 commits into
developfrom
cleanup-docs

Conversation

@MakisH

@MakisH MakisH commented Aug 3, 2026

Copy link
Copy Markdown
Member

I went through all the documentation and improved a bit the structure, the language, and removed some outdated content.

This PR is accompanied by this PR on the website: precice/precice.github.io#962

Summary:

  • Removed the very outdated page on building on SuperMUC - a system that does not exist anymore, and with comments that do not add much value on any other situation nowadays, especially since we no longer depend on yaml-cpp.
  • Since the documentation was moved from the website repository to this repository, depending on variables for the CalculiX and adapter versions that are defined in the website repository is strange and make the documentation confusing when viewed locally. I replaced these variables with hard-coded values, which anyway need to be updated together with the rest of the content when changing versions.
  • For the configure.md, I moved some sections around to make the page easier to follow, and fixed several language and other minor issues.

This PR will conflict with #146, so I am waiting to get that one merged first and handle the conflicts here.

@MakisH
MakisH marked this pull request as ready for review August 3, 2026 13:30
@MakisH
MakisH merged commit 08ca96d into develop Aug 3, 2026
4 checks passed
@MakisH
MakisH deleted the cleanup-docs branch August 3, 2026 13:30
@MakisH MakisH added this to the v2.20.2 milestone Aug 5, 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.

1 participant