when folks first navigate to the API docs, they should land on the first item in the list

[praneetloke]

(no more index page, the left nav is now the ever-present index)

[EvanBoyle]

Can you help clarify my understanding of the plan? Specifically what state we'd like to land in prior to making this change.

Today we have provider index pages:

https://www.pulumi.com/docs/reference/pkg/aws/

As well as module index pages:

https://www.pulumi.com/docs/reference/pkg/aws/accessanalyzer/

The current registry URL for provider api docs index:

http://registry-origin-pr-35-31edece4.s3-website.us-west-2.amazonaws.com/registry/packages/aws/api-docs/

Are we suggesting a temporary intermediate state where we have both /registry/packages/aws/api-docs as well as /docs/reference/pkg/aws?

[praneetloke]

I am not sure if that question is for me. But I'll answer this:

Are we suggesting a temporary intermediate state where we have both /registry/packages/aws/api-docs as well as /docs/reference/pkg/aws?

No that's not what I believe this is about. We will add redirects for reference/pkg/aws to registry/packages/AWS/api-docs. This issue is specifically about landing on the API Docs tab of a package in the registry and not seeing the module index pages you see today. Instead, this issue suggests to automatically select the first resource since the tree would allow a user to navigate between them.

The state we would be in closer to CES date is purely an incremental one from today once the left tree is added. That is, imagine today's API Docs experience with an added tree to the left.

[susanev]

wait what, the module index pages will still exist there was never any plan to change that. i thought this conversation was about the core index page of the packages, e.g., https://www.pulumi.com/docs/reference/pkg/aws/

the intent was for it to select the first resource yes, but in most cases that will be a module.

[susanev]

@praneetloke i think we can probably close this based on the review yesterday. we can always open it back up after ces if we get user feedback related to this. what do you think?

[praneetloke]

@susanev sounds good to me

[pulumi-bot]

Cannot close issue without required labels: kind/, resolution/