NUKnightLab / NUKnightLab/TimelineJS3
clarify docs w.r.t era row types
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.2k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
http://timeline.knightlab.com/docs/using-spreadsheets.html#title_slides
It is not clear here that a spreadsheet must contain rows that are events -- not all rows can be eras or there will be no actual events in the timeline (which causes an error)
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
Open the linked “Using spreadsheets” documentation at the title slides section and review the guidance on row types. Clarify that spreadsheets must include event rows, not only era rows, and explain that an all-era spreadsheet produces no actual events and causes an error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100