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

Move simvascular.github.io documentation to this repository #110

Open
mrp089 opened this issue Sep 23, 2023 · 0 comments
Open

Move simvascular.github.io documentation to this repository #110

mrp089 opened this issue Sep 23, 2023 · 0 comments

Comments

@mrp089
Copy link
Member

mrp089 commented Sep 23, 2023

Currently, our svFSI- documentation is in a different repository in some sub-directories.

I think having documentation and code in the same place would be good. This way, we can easily check/enforce that the documentation gets updated with the code. We can use our Doxygen build/deploy system and easily add existing (and new) markdown pages to the HTML documentation we're already building. We can link to this svFSI+ website from the main website.

The first step would be sorting through the existing documentation. It looks like part of the documentation isn't built currently, and other parts overlap with the documentation in this repository. I think this would also make sense for the other solvers.

Thoughts, @ktbolt, @MatteoSalvador?

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

No branches or pull requests

1 participant