alphagov / alphagov/tech-docs-gem
[Enhancement]: Add new layouts
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
What should change?
The tech docs layout is quite different from most GOV.UK Content. It would be great to be able to use different temapltes out of the box to allow for greater flexibility and use of approved GOV.UK designs and tested layouts, for example the GOV.UK Wifi homepage
User need
This would improve accessibility as well as allowing documentation to be tailored to the user need. It also helps the content to look more like gov.uk content
Proposed solution
Create a prototype using the GOV.UK Prototype Kit to try out a new layout and potentially release as a beta update to the template/gem
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 by reviewing the current tech docs layout alongside the GOV.UK Wifi homepage and the GOV.UK Prototype Kit. Define which approved layout should be prototyped and how it supports the stated accessibility and user needs. Done means a reviewed prototype with a clear path to a beta template or gem update.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- accessibility, design, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100