Skip to content

Migrate documentation from the website repository#30

Open
MakisH wants to merge 11 commits into
developfrom
from-website
Open

Migrate documentation from the website repository#30
MakisH wants to merge 11 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 migrate:
  • 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).

Christopher Lorenz and others added 11 commits May 22, 2026 17:31
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 MakisH requested a review from uekerman May 22, 2026 16:06
@MakisH MakisH self-assigned this May 22, 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.

4 participants