void-linux / void-linux/void-docs
Single-page version of Handbook?
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 217
- Forks
- 212
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 1
Description
Can/should we provide a single-page version of the Handbook? A user on IRC asked if there was one, and it seems to me that it would make it easier for users to search for particular terms within the Handbook.
Related: the above user noted that it was annoying to go to a page in the Handbook and find that it contained only a brief overview of the section. In a single-page version, i imagine this would be fine; but if we started adding ToCs for subsections (cf. https://github.com/void-linux/void-docs/pull/234), that might end up being unwieldy in a single-page version.
@ericonr, @bobertlo, thoughts?
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
Review the Handbook source and the subsection table-of-contents approach discussed in PR #234. Decide whether a single-page Handbook is desired and how its navigation should handle subsection contents; done means the scope and output format are agreed before implementation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100