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

x/website: show table of contents persistently in left-side panel #66769

Open
rushabhT3 opened this issue Apr 11, 2024 · 3 comments
Open

x/website: show table of contents persistently in left-side panel #66769

rushabhT3 opened this issue Apr 11, 2024 · 3 comments
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website

Comments

@rushabhT3
Copy link

What is the URL of the page with the issue?

https://go.dev/doc/effective_go#web_server

What is your user agent?

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36

Screenshot

Screenshot (729)

What did you do?

visited the page

What did you expect to see?

I expect the topics to be on the left side, not in the top corner. This way, I wouldn't have to scroll upwards repeatedly to choose a topic (please refer to the Node.js documentation for this).
I would also appreciate a built-in option to search by word.
I prefer more refined data presentation, so I don't have to search through a pile of information. I want pointers or separated headers, not just plain text. The current presentation is not what I expected.

What did you see instead?

chaotic design which could be much better.

@gopherbot gopherbot added this to the Unreleased milestone Apr 11, 2024
@adonovan
Copy link
Member

adonovan commented Apr 11, 2024

I expect the topics to be on the left side, not in the top corner. This way, I wouldn't have to scroll upwards repeatedly to choose a topic (please refer to the Node.js documentation for this).

That's a good idea. In the meantime, hit the Home button on your keyboard to reveal the contents.

I would also appreciate a built-in option to search by word.

Browsers are very good at rapidly searching even book-length documents. Hit Ctrl-F <term> RETURN to search.

I prefer more refined data presentation, so I don't have to search through a pile of information. I want pointers or separated headers, not just plain text. The current presentation is not what I expected.

I'm sorry you were disappointed. Could you give an example of a document that presents material of a similar kind, using what you consider to be a superior design? That would be a help.

@adonovan adonovan changed the title x/website: Enhancing User Experience: A Critique and Suggestions for Documentation Design x/website: feature: show table of contents persistently in left-side panel Apr 11, 2024
@adonovan
Copy link
Member

adonovan commented Apr 11, 2024

@rushabhT3
Copy link
Author

rushabhT3 commented Apr 12, 2024

Thank you for the Ctrl + F suggestion.
Capture
What I meant was, it would be helpful if you could add pointers like “1.” or “*-”… or something similar to what you can see in this text area’s options:
k
This is just a guideline, I would say. However, even when scrolling through the page, it doesn’t feel like a new topic has started. All I can say is that it may not be nicely segregated.

@cagedmantis cagedmantis added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Apr 12, 2024
@cagedmantis cagedmantis changed the title x/website: feature: show table of contents persistently in left-side panel x/website: show table of contents persistently in left-side panel Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website
Projects
None yet
Development

No branches or pull requests

4 participants