Skip to content

Migrate documentation from the website repository#30

Merged
MakisH merged 14 commits into
developfrom
from-website
May 24, 2026
Merged

Migrate documentation from the website repository#30
MakisH merged 14 commits into
developfrom
from-website

Conversation

@MakisH
Copy link
Copy Markdown
Member

@MakisH MakisH commented May 22, 2026

This PR migrates the documentation from the website repository, in an effort to keep the documentation close to the respective code. It also retains the Git history, to be able to go back in time, and to give credit to the committers.

I am updating this otherwise stagnant repository first because the content is little, the commits few, and the potential impact small.

I have rewritten all commit messages to:

  • Start with [DOCS]
  • Restrict to the remaining/related content
  • Add co-authors where missing (for the Wiki content)
  • Add a link to the original commit and any PR in the website repo, to make it easier to discover the complete history.

The resulting Git history is linear, with the original dates. To not mix these commits with the previous history (mainly because we refer to this adapter in the distribution with a commit), I would do a "rebase and merge" and delete this branch. This should still allow one to see the evolution and authors of the documentation.

After merging, I would make another PR on the website to remove the content (as usual) and set up the submodule.

If this goes well, I would apply the same to the remaining adapters that currently have their documentation on the website: CalculiX, deal.II, FEniCS. I exclude Nutils (no repository) and G+Smo (third-party repository).

@MakisH MakisH requested a review from uekerman May 22, 2026 16:06
@MakisH MakisH self-assigned this May 22, 2026
Christopher Lorenz and others added 12 commits May 24, 2026 17:49
Content in the wiki
co-authored-by: Michel Takken <39265603+micheltakken@users.noreply.github.com>

Wiki: https://github.com/precice/code_aster-adapter/wiki

Original commit:
precice/precice.github.io@51e3752
Content in the wiki
co-authored-by: Michel Takken <39265603+micheltakken@users.noreply.github.com>

Wiki: https://github.com/precice/code_aster-adapter/wiki

Original commit:
precice/precice.github.io@df887e5
MakisH added 2 commits May 24, 2026 17:57
Previous commits marked with [DOCS] originate from
https://github.com/precice/precice.github.io

This commit, in addition, makes URLs to the preCICE website absolute.

Added via #30
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.

4 participants