jasmine / jasmine/jasmine.github.io
Documentation difficult in v2
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 573
- Forks
- 411
- PR merge metrics
- No merged PRs in 30d
Description
https://jasmine.github.io/1.3/introduction
In version 1.x the documentation was very straightforward for getting started. I'd had another developer ask me how to write Jasmine, and I'd asked what they meant as the getting started guide was very clear last time I read it. I tried finding that information on the new site just to see what they meant.
I was expecting the getting started link to provide something like the introduction in 1.3, but ended up with a lot of "how to get started in x". This is useful, but I couldn't find a general "how to write jasmine" section from there.
Perhaps I was looking in the wrong place, but I feel that the site should be organized to expose this information more immediately.
Contributor guide
No contributing guide indexed for this repository
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
Compare the current getting-started documentation with the linked Jasmine 1.3 introduction to identify where general guidance is missing or hard to find. Reorganize or add the documentation so a reader can reach a general “how to write Jasmine” guide immediately, while retaining the useful platform-specific guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100