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

Current location of documentation is problematic #114

Open
IshaanDesai opened this issue Jul 25, 2021 · 3 comments
Open

Current location of documentation is problematic #114

IshaanDesai opened this issue Jul 25, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@IshaanDesai
Copy link
Member

IshaanDesai commented Jul 25, 2021

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 IshaanDesai self-assigned this Jul 25, 2021
@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label Jul 25, 2021
@IshaanDesai IshaanDesai changed the title Correct location of documentation Correct location of documentation is problematic Jul 25, 2021
@uekerman
Copy link
Member

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

@IshaanDesai
Copy link
Member Author

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 IshaanDesai changed the title Correct location of documentation is problematic Current location of documentation is problematic Oct 15, 2021
@BenjaminRodenberg
Copy link
Member

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

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.

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

No branches or pull requests

3 participants