Skip to content

Structural Updates to Docs #1207

@mujahidkay

Description

@mujahidkay
  • 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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions