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

split documentation to 2 parts #353

Closed
wants to merge 1 commit into from
Closed

split documentation to 2 parts #353

wants to merge 1 commit into from

Conversation

bung87
Copy link
Contributor

@bung87 bung87 commented Jan 1, 2023

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: #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
Copy link
Member

See also #276

@bung87
Copy link
Contributor Author

bung87 commented Jan 2, 2023

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
Copy link
Member

cc @narimiran

@narimiran
Copy link
Member

It was unified on purpose.

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

@narimiran narimiran closed this Jan 3, 2023
@bung87
Copy link
Contributor Author

bung87 commented Jan 3, 2023

that's two click + one scroll.

@rockcavera
Copy link
Contributor

rockcavera commented Jan 4, 2023

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
Copy link
Contributor Author

bung87 commented Jan 4, 2023

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
Copy link

ZoomRmc commented Jan 4, 2023

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

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

Successfully merging this pull request may close these issues.

5 participants