nim-lang / website

Code for the official Nim programming language website
https://nim-lang.org
Other
115 stars 78 forks source link

split documentation to 2 parts #353

Closed bung87 closed 1 year ago

bung87 commented 1 year ago

adjust navigation

for beginner: they see features -> learn a bit of nim -> install it try play with

for non-beginner:

click Documentation , check manual and document references directly.

it's a bit weird feeling, click "Documentation" and see "Getting started with Nim" for me.

refs: https://github.com/nim-lang/website/issues/318 likely fit this

maybe add more commit to cover #242 in this PR as well. after investigation it's not a stable choice for putting it into main navigation. but put "Nimble Package Manager" and "Nimble Package Directory" sections together seems to be a improvement to me.

change "Documentation" to "Docs" and "Download" to "Install" make the navigation shorter, might not feel hesitant for adding extro "Packages" link.

and another thing I noticed is "Community" seems to be a stable choice putting into main navigation on language offical sites.

ringabout commented 1 year ago

See also https://github.com/nim-lang/website/pull/276

bung87 commented 1 year ago

See also #276

It's really bad idea to me, I don't find reason scroll down full screen to find the "Documentation" links

ringabout commented 1 year ago

cc @narimiran

narimiran commented 1 year ago

It was unified on purpose.

"I have to scroll" is not a real problem, sorry.

bung87 commented 1 year ago

that's two click + one scroll.

rockcavera commented 1 year ago

I also didn't like it when everything was unified under the Documentation link. The official documentation is lost among several other links (several that go outside of Nim itself).

I preferred the previous approach, where we had Learn and Documentation.

Edit: see my indignation when the unification happened

bung87 commented 1 year ago

see my indignation when the unification happened” , oh , as a experienced web developer, I'll convincing the ui designer or product manger change the idea. or atleast this won't be done by my hand.

ZoomRmc commented 1 year ago

Clearly, the manual, being the best specs we have, should be treated differently as the main source of truth (besides the actual code).