crossplane / crossplane/docs

Improve expand box ("accordion") visibility

Open
#480 7 comments 0 reactions 0 assignees View on GitHub
infrastructure P1
Dominant language
SCSS
Stars
60
Forks
163
Avg merge
15h 20m
Merged PRs (30d)
9

Description

Spinning out of #473-

expand shortcode blocks are easy to miss
The [expand shortcode](https://docs.crossplane.io/contribute/features/#hide-long-outputs) is used to hide blocks of text by default. However, in practice these blocks are really easy to miss when reading or scanning a doc, so I think the content hidden by them very rarely gets viewed.

A specific case where this hurts is when a search result is hidden in one of these blocks. e.g. searching the docs for EnvironmentConfig yields one page result that takes you to [docs.crossplane.io/latest/software/install](https://docs.crossplane.io/latest/software/install/). If you then use your browser to "find on page", you get 0 results. EnvironmentConfig looks to not actually be on that page at all, but it's actually hidden underneath the "[feature flags](https://docs.crossplane.io/latest/software/install/#feature-flags)" expand block.

Can the expand blocks be made more visually noticeable?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.