Skip to content

Expand sections in README.md #1061

@lgarron

Description

@lgarron

Problem(s) addressed

https://github.com/mas-cli/mas is really difficult to peruse right now, because it's necessary to expand each <details> section one-at-a-time to read.

This is compounded by the fact that the header link anchor (as currently added by GitHub) significantly overlaps with the expansion icon:

Image

Proposed solution(s)

Expand all the sections. I think a lot of projects on GitHub do fine with this.

If it's a concern that people will not immediately be able to identify some sections, they can be linked from the top like this:

Having trouble? Take a look at known issues and troubleshooting.

Metadata

Metadata

Assignees

Labels

🧊 backlogPostponed: requires more info, requires too much effort for payoff, etc.🧽 choreAdministrative task: documentation, build, test, release, git, etc.

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions