Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Group Inputs and Fields in documentation to allow better discoverability #5440

Merged
merged 1 commit into from
Oct 26, 2020

Conversation

fzaninotto
Copy link
Member

Problem

The fields and Inputs doc table of content are intimidating because they show too much content. Besides, the toc is too long and doesn't show the last elements on small screens

Solution

Users use the reference and full-text search to get to a given input doc anyway, so let's use heading levels for discoverability.

Add a new heading level and group Inputs and Fields by category

Before

image

After

image

Demo

input-toc

@fzaninotto fzaninotto added the RFR Ready For Review label Oct 26, 2020
Copy link
Contributor

@Luwangel Luwangel left a comment

Choose a reason for hiding this comment

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

It is difficult to review the changes because of Github. So I took a quick look at it and it looks good to me.

@Luwangel Luwangel merged commit 6707153 into master Oct 26, 2020
@Luwangel Luwangel deleted the field-input-doc-structure branch October 26, 2020 13:25
@Luwangel Luwangel added this to the 3.9.6 milestone Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants