Skip to content

Reorient docs toward a task-based structure #19211

Open
@colindean

Description

Verification

Provide a detailed description of the proposed feature

The Docs track of the AGM agreed on an observation that many of our docs could be reorganized to prioritize objective task completion instead of often lengthy system or operations descriptions.

Contrived examples, totally not intended to be actually used:

Current: System/ops description Proposed: Task-oriented title
Taps
  • Create and manage collections of Formulae and Casks with Taps
  • Hosting a third-party repository for Taps
brew livecheck
  • Implementing an effective livecheck
  • Choose a livecheck strategy

This would be a large body of work and may necessitate breaking up large documents and ensuring there is a table of contents on some pages.

What is the motivation for the feature?

While seasoned maintainers may know exactly where look for help on a subject having seen it in the docs before and needing a refresher, folks new to the docs or infrequent users may benefit from a browsable structure that presents a selection of common tasks, perhaps collected by area.

How will the feature be relevant to at least 90% of Homebrew users?

All maintainers benefit from clear documentation, and most users looking for help would benefit from a more browseable set of titles and headers that are more likely to align with their current task.

What alternatives to the feature have been considered?

We may be outgrowing our current documentation system, but this work should not yet necessitate such a move.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions