python-bindings icon indicating copy to clipboard operation
python-bindings copied to clipboard

Current location of documentation is problematic

Open IshaanDesai opened this issue 3 years ago • 3 comments

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?

IshaanDesai avatar Jul 25 '21 09:07 IshaanDesai

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 ...

uekerman avatar Jul 30 '21 11:07 uekerman

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 :+1:

IshaanDesai avatar Jul 30 '21 11:07 IshaanDesai

I started updating some of the documentation on our website to add some new developments

  • https://github.com/precice/precice.github.io/commit/4b299fdc3347277f24ca525b8d63394c2adb98b3
  • https://github.com/precice/precice.github.io/commit/0ef56ab054ad892f9d20e8aa1424978b1f8364a5

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.

BenjaminRodenberg avatar Feb 22 '22 15:02 BenjaminRodenberg