rust-lang / rust-lang/rust-by-example
Suggestion: Add basic progress tracking to website
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
Problem
The examples are great, however they are not completable in one sitting. So if someone goes through them over time, in multiple sittings, it might get difficult to remember where they stopped when next opening the site
Proposal
Track which examples a user has "completed", and show this in the UI, e.g. a checkmark next to the examples.
For a basic implementation, completion could just mean the user has viewed the example and pressed the "next" button.
The completion state can be stored in local storage for persistence.
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.
Research direction
Start at the examples UI and locate the Next button and the list of examples it advances through. Determine how browser state can persist across visits, then define completion and checkmark behavior; done means viewed examples remain marked after reopening the site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- handlebars, javascript
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100