[Task] Add a screenshot of the dashboard to the README
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start with README.md near the top, where the logo already uses a <picture> with prefers-color-scheme, and copy that pattern. Set up the dashboard using CONTRIBUTING.md, then import the dashboard/tests/fixtures/progress/mid-course/progress.json fixture and run npm run dashboard to capture the home view with a path and next lesson. Done when assets/ holds light and dark PNGs about 1600 px wide and compressed, and the README picks between them with a descriptive alt.
Written by the indexing model from the issue text.
Description
Summary
Add one screenshot near the top of the README showing the dashboard (home with a path and the next lesson), in light and dark versions.
Why
The README explains LessonFolk in text only. A visitor should see what it looks like before reading.
Scope
- Two PNG files in
assets/(light and dark), about 1600 px wide, compressed - A
<picture>inREADME.mdthat picks one withprefers-color-scheme, like the logo, with a descriptivealt
Notes
Use a fixture for a realistic state, with no personal data: npm run progress:import -- dashboard/tests/fixtures/progress/mid-course/progress.json, then npm run dashboard. Setup: CONTRIBUTING.md.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- Avg merge
- 1h 18m
- Merged PRs (30d)
- 149
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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 CGSeb/lessonfolk
-
dashboard enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
CGSeb/lessonfolk#200 ·
Maintainers usually reply within 1 day
-
course help wanted
Difficulty 3/5 1-2 days Newbie friendliness 45/100
CGSeb/lessonfolk#199 ·
Maintainers usually reply within 1 day
-
infra security
Difficulty 4/5 3-5 days Newbie friendliness 32/100
CGSeb/lessonfolk#150 ·
Maintainers usually reply within 1 day
All issues in CGSeb/lessonfolk
Similar issues
-
Area/Cloud Needs Triage Type/Bug
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
wso2/product-integrator#2847 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
bluesky-social/social-app#12118 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
heygen-com/hyperframes#6021 ·
Maintainers usually reply within 1 day
-
check:passed streams:edit
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day