NUKnightLab / NUKnightLab/TimelineJS3
Link timeline error messages to FAQ where possible
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.2k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
If we give errors simple IDs, we could use those IDs as internal links in timeline.knightlab.com/docs/faq.html and we could also use those IDs as keys to look up a message in the L10N file for the language selected for the current timeline. (It will take a lot of time to fill in the translations for those keys, but it's better to set up for it if we can without too much trouble.)
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 by reviewing the error-handling flow and the FAQ at timeline.knightlab.com/docs/faq.html, then locate the L10N file used for the selected timeline language. Determine how error IDs could connect messages to FAQ anchors and localized lookup keys. Done means the approach is established and the relevant errors can use both links and localized messages without requiring all translations immediately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, localization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100