You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the python-bindings documentation lies in a README to which even the website documentation is redirected to. I propose to move most part of the documentation to the website and only keep the bare minimum in the README. This would be in alignment with the preCICE repository. Any objections to this?
The text was updated successfully, but these errors were encountered:
In principle, yes, but the even better solution would be the move the documentations into a folder docs and render it on the website. Similar, to how we treat e.g. the OpenFOAM adapter docs. If we already touch it ...
In principle, yes, but the even better solution would be the move the documentations into a folder docs and render it on the website. Similar, to how we treat e.g. the OpenFOAM adapter docs. If we already touch it ...
Ah yes indeed, this would be the best way to do it. I will kick off this porting in the next week 👍
IshaanDesai
changed the title
Correct location of documentation is problematic
Current location of documentation is problematic
Oct 15, 2021
I think we can actually delete a lot of the information in the README.md or move it somewhere else. Most of the troubleshooting is not so relevant anymore, because installation procedures have greatly improved. I would still keep the dev docs here (testing, building from source). I can quickly prepare a PR where we can continue this discussion.
Currently the
python-bindings
documentation lies in a README to which even the website documentation is redirected to. I propose to move most part of the documentation to the website and only keep the bare minimum in the README. This would be in alignment with the preCICE repository. Any objections to this?The text was updated successfully, but these errors were encountered: