Skip to content

Review path of a new user through documentation and revise page flow #734

@WasabiFan

Description

@WasabiFan

After finding the "Getting started" page on our website, a new user could easily get lost when trying to get to the point of actually writing code. I think we need to:

  • Make the links to the "Libraries" page more obvious and natural as the next step (maybe even make it a button saying "Next"?)
  • Demote the low-level driver docs
    • Make it easiest to find the motor class and sensor class documentation, without having to search or jump through hoops
  • Make sure that a user goes through the process of configuring networking (including SSH, see Add SSH tutorial #727) before being routed to any library documentation
  • Recommend the simplest networking options first. I think the simplest is "buy a Wi-Fi dongle".
  • Remove links to empty "TODO" pages. These pages should still exist and we should look to get them filled, but until then we need to make sure that users don't stumble across them and get confused.
    • Make sure we aren't recommending nonexistent options
  • Promote reporting issues and getting in chat (so, essentially the support page)
  • Move the "Get help" link so that it is more obvious
  • Add more "landing pages" for categories of documentation, and make it easy to find them (especially via the documentation landing page). We at least need pages for "Connecting to the internet/a network", "Writing code using a library" and "Interfacing with ev3dev drivers directly".
  • Explain what ev3dev is

Essentially, I want to make sure that any user can get ev3dev running and then write some code in as few steps as possible, while also having the option to find the lower-level docs if necessary. At this point, the low-level bits are not important to the vast majority of users as far as I know. For the ones that do need them, however, we need to make sure that those sections are there.

cc @ndward

Related: #733

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions