Skip to content

Conversation

@SeanNaren
Copy link
Contributor

@SeanNaren SeanNaren commented Aug 3, 2021

What does this PR do?

Closes #8693

The goal is to improve discoverability when using the docs of different cases. We've grouped quite a bit into the drop down which hides and obfuscates imo important information.

To improve this, I suggest we go from this:

Screenshot 2021-08-03 at 11 47 04

to this:

Screenshot 2021-08-03 at 11 45 10

Negatives are that dropdown options below common use cases require scrolling, however I think this is fine given the priority of showing features that we support out the box on the left.

Hopefully this sparks discussion!

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@SeanNaren SeanNaren changed the title Expand the use cases, move them up for discoverability [docs] Expand use cases, move them up for discoverability Aug 3, 2021
@codecov
Copy link

codecov bot commented Aug 3, 2021

Codecov Report

Merging #8692 (4bb860b) into master (08ac079) will decrease coverage by 4%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #8692    +/-   ##
=======================================
- Coverage      93%     89%    -4%     
=======================================
  Files         167     167            
  Lines       14037   14037            
=======================================
- Hits        13008   12453   -555     
- Misses       1029    1584   +555     

@SeanNaren SeanNaren marked this pull request as ready for review August 3, 2021 11:26
@SeanNaren SeanNaren added this to the v1.5 milestone Aug 3, 2021
@SeanNaren SeanNaren added the docs Documentation related label Aug 3, 2021
@SeanNaren SeanNaren self-assigned this Aug 3, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@mergify mergify bot added the ready PRs ready to be merged label Aug 3, 2021
@SeanNaren SeanNaren enabled auto-merge (squash) August 3, 2021 11:42
@SeanNaren SeanNaren merged commit a1be621 into master Aug 3, 2021
@SeanNaren SeanNaren deleted the doc/expand_use_cases branch August 3, 2021 11:47
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very nice!

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

Labels

docs Documentation related ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RFC][Docs] Expand Common Use Cases to improve discoverability

5 participants