Doc Feedback: Include Additional Headers in the API Console content
Open
Nobody has claimed this yet.
API-M-3.2.0
API-M-4.0.0
Docs/TW
Severity/Minor
Type/Bug
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
At the start of the doc, there is a note and it talks about a first step.
And then after the note, the paragraph starts with
Next,.....
@Mariangela does this intuitive enough?
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
Start with the page at the linked documentation URL, especially the opening note and the paragraph beginning “Next”. Determine whether the sequence is intuitive and identify the wording that needs clarification; done means the first step and following instruction read as a clear sequence.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100