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

Docsite: inconsistency between landing page, submenus and pages #207

Open
june-andronick opened this issue Nov 21, 2023 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@june-andronick
Copy link
Contributor

june-andronick commented Nov 21, 2023

(This may wait for the Information Architecture feedback first)

  • The landing page has a nice overview but it's not clear that this is just a subset of the docsite content. We should make that clear.

  • The order and titles on the landing page and the submenus should be made consistent to avoid confusion. E.g.

    • "Building Dependencies" vs "Set up your machine" vs "Host dependencies"
    • "Hardware and Target platforms" vs "Supported hardware" vs "Supported Platforms"
    • "Contributing" on the landing page goes to the "Processes" page and the "Contributing processes" goes to the "Contributing" page
    • ...
  • The Grouping should be consistent; namely "The source code" appears in "Getting started" in the landing page but belongs to "Contributing" submenu

  • the "Roles" page appears in the landing page but not in the submenus. There's a question on location of this page versus having it on the website with the TSC information (see also issue 309 on website)

  • All the links from the tutorial section on the landing page are wrong, going to the same root Tutorials page (Docsite: inconsistent links for tutorials #206)

@june-andronick june-andronick added the enhancement New feature or request label Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant