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

Move examples further down on the docs page #3929

Open
Tracked by #3925
sean1588 opened this issue Feb 7, 2024 · 2 comments
Open
Tracked by #3925

Move examples further down on the docs page #3929

sean1588 opened this issue Feb 7, 2024 · 2 comments
Assignees
Labels
size/M Estimated effort to complete (up to 5 days).

Comments

@sean1588
Copy link
Member

sean1588 commented Feb 7, 2024

Move examples to further down on the docs page. Currently they are the first to display after the resource's description. They should follow after the input/output properties section.

@sean1588 sean1588 changed the title move examples to the end of the docs page Move examples to the end of the docs page Feb 7, 2024
@sean1588 sean1588 self-assigned this Feb 8, 2024
@sean1588 sean1588 added size/M Estimated effort to complete (up to 5 days). and removed needs-triage labels Feb 8, 2024
@sean1588 sean1588 changed the title Move examples to the end of the docs page Move examples further down on the docs page Feb 27, 2024
@lukehoban
Copy link
Member

I'm not apriori sure this is a good thing. I would argue the examples are the highgest used part of these pages, and if anything, the fact that we have them collapsed by default actually is limiting usability of the pages overall.

@toriancrane
Copy link
Contributor

I'm not apriori sure this is a good thing. I would argue the examples are the highgest used part of these pages, and if anything, the fact that we have them collapsed by default actually is limiting usability of the pages overall.

I believe the addition of a complete/syntactically correct resource definition would provide greater value being higher on the page given that the examples are often not comprehensive of all available input properties/configurations. There are also more pedagogical benefits in this approach as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Estimated effort to complete (up to 5 days).
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

3 participants