alphagov / alphagov/tech-docs-gem
[Documentation]: Document using the linter
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
Is this
- a suggestion for new content
- an update to existing content
- a suggestion to remove content
User need
In the docs, we should explain:
- this functionality exists
- how to use this functionality (either manually or as part of a pipeline)
Replaces: issue 230
Proposed solution
No response
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
No file, test, or entry point is named. Find the relevant documentation location and establish how the linter is invoked manually and in a pipeline; done means the docs explain that the functionality exists and cover both usage paths.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100