Skip to content
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

Merged
merged 12 commits into from
Apr 12, 2021
Merged

Update deal.II adapter docs #39

merged 12 commits into from
Apr 12, 2021

Conversation

davidscn
Copy link
Member

@davidscn davidscn commented Mar 22, 2021

@davidscn davidscn self-assigned this Mar 22, 2021
@davidscn
Copy link
Member Author

davidscn commented Mar 22, 2021

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 davidscn added the documentation Improvements or additions to documentation label Mar 22, 2021
@davidscn
Copy link
Member Author

davidscn commented Mar 23, 2021

TODO: Add link to parameter file reference.

@MakisH
Copy link
Member

MakisH commented Apr 12, 2021

@davidscn is this ready for reviewing?

@davidscn
Copy link
Member Author

Yes

@MakisH MakisH self-requested a review April 12, 2021 11:56
Copy link
Member

@MakisH MakisH left a 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 $$ in adapter-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.

@davidscn
Copy link
Member Author

Thanks!

Have you tried directly inserting the equations with $$ equation $$ in adapter-dealii-solver-details.md?

No, I have not, the formatting is currently nice and for me it is low-priority to change it.

In the file adapter-dealii-coupling-meshes.md there is a todo [Add link to other Doc page].

Will fix it.

@davidscn davidscn merged commit 94bf3e1 into master Apr 12, 2021
@davidscn davidscn deleted the update-deal.II-docs branch April 12, 2021 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants