golang / go

The Go programming language
https://go.dev
BSD 3-Clause "New" or "Revised" License
123.98k stars 17.67k forks source link

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

Open rushabhT3 opened 7 months ago

rushabhT3 commented 7 months ago

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.

adonovan commented 7 months ago

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 commented 7 months ago

See also:

rushabhT3 commented 7 months ago

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.