audreyfeldroy / audreyfeldroy/complexity

Improve the Complexity tutorial

Open
#19 0 comments 0 reactions 0 assignees View on GitHub
docs help wanted
Dominant language
Python
Stars
118
Forks
31
PR merge metrics
No merged PRs in 30d

Description

This is a first attempt at a Complexity tutorial:
http://complexity.readthedocs.org/en/latest/tutorial.html

It could use some reviewing from someone who's never used Complexity:
- What is confusing?
- What can be improved?
- What would make it flow better?

If you have feedback, comment here.

If you have enough experience to feel comfortable doing so, please submit a pull request with improvements. (Don't worry about this if feedback is easier, though.)

Contributor guide

Open the contributing guide

Research direction

Start with the Complexity tutorial at http://complexity.readthedocs.org/en/latest/tutorial.html and read it as someone who has never used the project. Note confusing explanations and flow issues, then review the relevant tutorial content. Done means the tutorial has clearer guidance and the improvements are submitted as a pull request, or specific feedback is provided in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.