-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
basicdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Description:
As you onboard to HyPyP, document every friction point you encounter. This log will help us identify and fix the biggest barriers for newcomers.
Context:
The best way to improve onboarding is to capture real struggles from real newcomers. Your fresh perspective is invaluable!
Tasks:
- Clone the repo and attempt to install HyPyP
- Try to run the
getting_started.ipynbtutorial - Document each friction point in the shared log (template below)
- Propose a solution or wording fix for each issue
Friction Log Template:
| Step | What I tried | What went wrong | Proposed fix |
|---|---|---|---|
| Install | pip install hypyp |
Missing dependency X | Add X to requirements |
| Tutorial | Run cell 5 | Error: "No module Y" | Add import statement |
| Docs | Find PLV docs | Couldn't find it | Add link in README |
Acceptance Criteria:
- At least 5 friction points documented
- Each friction point has a proposed solution
- Log is in shared Google Doc or Markdown file
- Severe blockers are flagged for immediate attention
Metadata
Metadata
Assignees
Labels
basicdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed