Add `option` key to the documentation
Open
Nobody has claimed this yet.
documentation
website
- Dominant language
- SCSS
- Stars
- 10
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Add option key to the documentation
- Update the keys summary: https://github.com/scanapi/website/blob/main/_docs_v1/specification/api_specification_keys.md
- Create a file called
option.mdhere to explain how to useoptionskey.
Options Key: https://github.com/scanapi/scanapi/pull/552
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 with _docs_v1/specification/api_specification_keys.md and review the option-related implementation described in ScanAPI pull request 552. Create _docs_v1/specification/option.md explaining how to use the options key, then update the keys summary to include it. Done means both documentation locations describe the key consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100