Add user guide/examples/tutorials
@IvanIsCoding is already working on this.
Since Nov 19, 2021.
Assessment
This issue has not been assessed yet.
Description
What is the expected enhancement?
Right now our documentation is mainly focused on api references with some small examples in the class documentation and release notes. It would be great if we had a user guide in the documentation top explain at a higher level how to interact with retworkx, working with graphs/networks, and accomplishing some concrete tasks using retworkx. Some good examples of documentation like this:
- https://qutip.org/docs/latest/guide/guide.html
- https://numpy.org/doc/stable/user/absolute_beginners.html
Writing documentation like this will also be good for exposing any API or functionality gaps in retworkx.
- Dominant language
- Rust
- Stars
- 1.8k
- Forks
- 220
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Qiskit/rustworkx
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 65/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
All issues in Qiskit/rustworkx
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100