precice / precice/python-bindings

Current location of documentation is problematic

Open
#114 3 comments 3 reactions 1 assignee View on GitHub

@IshaanDesai is already working on this.

Since Jul 25, 2021.

documentation
Dominant language
Cython
Stars
30
Forks
19
No merged PRs in 30d

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.