Validate the examples
Open
Nobody has claimed this yet.
system
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
The examples from the old documentation were validated by a very simple script that should be ported to the new docs repo.
When someone implements #54 the validation could be even more thorough.
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
Locate the simple validation script used with the old documentation and compare it with the structure of this new docs repository. Determine how the examples are identified and executed, then confirm that the port validates the examples and reports failures; issue #54 may define a later, more thorough scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100