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

[Docs]: The main category pages are only available through the breadcrumbs #2134

Closed
anth-git opened this issue May 28, 2024 · 5 comments
Closed
Assignees

Comments

@anth-git
Copy link

anth-git commented May 28, 2024

Describe the bug

On www.pollydocs.org there are no direct links to category pages, such as Resilience pipelines, Chaos engineering, etc

For example in order to open https://www.pollydocs.org/chaos/index.html one needs to open the Chaos engineering menu, then click on Fault, and after the page loads, click on Chaos engineering from the breadcrumbs.

This is very confusing, because it appears that there is no introduction to the topics.

image

Also breadcrumbs seem to be backwards.

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

No response

Exception(s) (if any)

No response

Polly version

No response

.NET Version

No response

Anything else?

No response

@anth-git anth-git added the bug label May 28, 2024
@anth-git anth-git changed the title [Doc]: The main category pages are only available through the breadcrumbs [Docs]: The main category pages are only available through the breadcrumbs May 28, 2024
@martincostello martincostello added help wanted A change up for grabs for contributions from the community documentation labels May 28, 2024
@martincostello
Copy link
Member

The fix is for us to update the table of contents to add the summary topics at the top of each dropdown.

@peter-csala
Copy link
Contributor

Assign to me

@martincostello martincostello removed the help wanted A change up for grabs for contributions from the community label May 28, 2024
@peter-csala
Copy link
Contributor

Which one would be the preferred the approach?

No dropdown on the top, lhs submenu

Screenshot 2024-05-28 at 16 12 14

Dropdown on the top, clumsy breadcrumb

Screenshot 2024-05-28 at 16 15 00

Of course we can use other name to the index page than the parent name

@martincostello
Copy link
Member

I think I prefer the first option, but there's not much in it.

@martincostello
Copy link
Member

Thanks for reporting this issue. The documentation was updated by #2136 to resolve this.

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

No branches or pull requests

3 participants