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

Structural Updates to Docs #1207

Open
mujahidkay opened this issue Sep 13, 2024 · 1 comment
Open

Structural Updates to Docs #1207

mujahidkay opened this issue Sep 13, 2024 · 1 comment

Comments

@mujahidkay
Copy link
Member

mujahidkay commented Sep 13, 2024

  • The page (and docs) are really starting to come together. I have some feedback around the main navigation parents/children items. I think we could use more hierarchy to how the children links are organized - I think it is at the point where a category label could be helpful, and even further down the road a mega-menu type layout
image
  • For the side nav - "takeaway x:" seems unnecessary, I would just title and label it "Starting a Local Chain" and update the other items.
image
  • There is a lot of truncation on the right side nav, where the first words are more generic and the truncated part seems more important - consider cutting those words down so we can see the full title
image

Example: "Creating your Dapp from a Template" -> "Creating from a Template"
Example: "Starting the Dapp Smart Contract" -> "Starting the Smart Contract"

  • The page is long and could seem overwhelming for a Getting Started page. Consider adding in the copy up top "Get started in 5 steps" to help set some expectations.

or visit https://classic.yarnpkg.com/en/docs/install for more information -> or visit the official yarn package

  • I would guide them to the next logical location to hand hold them a bit more like "creating your first smart contract with our hello world example"
image

Originally posted by @mitdralla in #1201 (comment)

@mujahidkay
Copy link
Member Author

I think we could use more hierarchy to how the children links are organized - I think it is at the point where a category label could be helpful, and even further down the road a mega-menu type layout

@mitdralla do these (somewhat) align with what you proposed here? [ The Overview points to where the sections currently lead ]

Build Dropdown Tutorial Dropdown
Screenshot 2024-09-13 at 7 21 59 PM Screenshot 2024-09-13 at 7 22 11 PM

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

No branches or pull requests

1 participant