-
-
Notifications
You must be signed in to change notification settings - Fork 60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update deal.II adapter docs #39
Conversation
The docs were quiet outdated. Not sure if anyone wants to review here. Ready to merge. We should delete the adapter wiki as a post-merge step. |
|
@davidscn is this ready for reviewing? |
Yes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few notes:
- Don't forget the opening and closing quotes in the alert contents.
- In the "Get the adapter", I moved the hidden advanced "building in production" step in a subsection, because I could not make the
<details>
node work. It was broken before. Apparently, the same tricks from GitHub do not apply here. - I changed
"${PATH}:/path/to/dealii/adapter/elasticity"
to"/path/to/dealii/adapter/elasticity:${PATH}"
(prepending instead of appending, i.e. search first our custom path) (FYI) - Have you tried directly inserting the equations with
$$ equation $$
inadapter-dealii-solver-details.md
? - In the file
adapter-dealii-coupling-meshes.md
there is a todo[Add link to other Doc page]
.
Feel free to address as many of these points as you want and merge.
Thanks!
No, I have not, the formatting is currently nice and for me it is low-priority to change it.
Will fix it. |
Related to precice/dealii-adapter#50 and precice/tutorials#166 and to be merged with precice/tutorials#160.