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.

Sign up for GitHub

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

Jump to bottom

Make a link to API Docs more prominent on Provider landing pages #5458

Open
mikhailshilkov opened this issue Sep 19, 2024 · 0 comments
Open

Make a link to API Docs more prominent on Provider landing pages #5458

mikhailshilkov opened this issue Sep 19, 2024 · 0 comments
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features p2 Bugs that aren't P1s but should be done within the quarter

Comments

@mikhailshilkov
Copy link
Member

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

A question about our provider API docs landing page like https://www.pulumi.com/registry/packages/cloudflare/

If the width of the page is small-ish (e.g. on mobile or a half of my laptop screen) and the left nav bar is collapsed, it seems really hard to guess how to find actual API Docs. There is no link to them other than in the collapsed pane. Should we somehow add it to the main pane?

Image

Affected area/feature
@mikhailshilkov mikhailshilkov added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Sep 19, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Sep 19, 2024
@thoward thoward added area/registry impact/usability Something that impacts users' ability to use the product easily and intuitively area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. p2 Bugs that aren't P1s but should be done within the quarter and removed needs-triage Needs attention from the triage team labels Sep 26, 2024
@thoward thoward moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features p2 Bugs that aren't P1s but should be done within the quarter
Projects
Docs 📚
Status: 🧳 Backlog
Milestone
No milestone
Development

No branches or pull requests
3 participants
@thoward @mikhailshilkov @iwahbe