Skip to content

docs: Add docs for thermoelastic3d#218

Merged
g-braeunlich merged 2 commits intomainfrom
problem-docs-thermoelastic3d
Feb 5, 2026
Merged

docs: Add docs for thermoelastic3d#218
g-braeunlich merged 2 commits intomainfrom
problem-docs-thermoelastic3d

Conversation

@g-braeunlich
Copy link
Collaborator

Description

This adds docs for thermoelastic3d, which I missed in the previous PR

Type of change

Please delete options that are not relevant.

  • Documentation only change (no code changed)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files
  • I have run ruff check . and ruff format
  • I have run mypy .
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Reviewer Checklist:

  • The content of this PR brings value to the community. It is not too specific to a particular use case.
  • The tests and checks pass (linting, formatting, type checking). For a new problem, double check the github actions workflow to ensure the problem is being tested.
  • The documentation is updated.
  • The code is understandable and commented. No large code blocks are left unexplained, no huge file. Can I read and understand the code easily?
  • There is no merge conflict.
  • The changes are not breaking the existing results (datasets, training curves, etc.). If they do, is there a good reason for it? And is the associated problem version bumped?
  • For a new problem, has the dataset been generated with our slurm script so we can re-generate it if needed? (This also ensures that the problem is running on the HPC.)
  • For bugfixes, it is a robust fix and not a hacky workaround.

@g-braeunlich g-braeunlich self-assigned this Jan 28, 2026
@g-braeunlich g-braeunlich requested a review from markfuge January 28, 2026 16:40
Copy link
Member

@markfuge markfuge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @g-braeunlich I think this is largely good, except I found a few things:

  1. The image is missing (i.e., img/problems/thermoelastic3d.png). Perhaps @gapaza can help you with this?
  2. The link to the problem is missing from the right side nav bar. Perhaps we can take an approach similar to HeatConduction where we have boht 2D and 3D problems?

Can @gapaza take a look as well on the technical side to make sure everything is correct and renders properly?

@markfuge markfuge requested a review from gapaza February 3, 2026 07:32
@gapaza
Copy link
Contributor

gapaza commented Feb 4, 2026

Taking a look at this today! I will add both the docs and the image as requested.

@gapaza
Copy link
Contributor

gapaza commented Feb 4, 2026

Ok, I just added the image and modified the index.md file to include the thermoelastic3d documentation (I also made sure to use the correct docs(project) commit tag as we just discussed). I downloaded the documentation from the GitHub action as Mark showed me and everything looks ok to me.

@g-braeunlich
Copy link
Collaborator Author

Thanks a lot!
@markfuge do we want to merge?

Copy link
Member

@markfuge markfuge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep approved. Merge when ready @g-braeunlich

@g-braeunlich g-braeunlich merged commit 493a68c into main Feb 5, 2026
15 of 17 checks passed
@g-braeunlich g-braeunlich deleted the problem-docs-thermoelastic3d branch February 5, 2026 10:10
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.

3 participants