Skip to content

Add User Guide information to CASEI UI #674

@LanesGood

Description

@LanesGood

Motivation

The ADMG team is producing user guide text and video content to help users understand and explore the CASEI UI.

Potential solutions

The CASEI UI already includes a "FAQ" section. The new user guide content will not simply be frequently asked questions, but will instead be a walkthrough and source of guidance for using the platform from start to finish. @EJwalker13 has proposed the first two following options; I am adding a third to this list. The new content may be housed in:

  1. A new page, linked from the main page header navigation, titled "Guide/Help"

    • Pros: A completely new section could ensure that users know where to turn for guidance, and distinguish this information from the FAQ
    • Cons: An additional top-level menu item make over-prioritize the non-scientific informational content of the site

    image
    A mock navigation bar with a new page

  2. A section of the FAQ titled "User guidance/documentation"

    • Pros: The FAQ section already exists. Adding new content would be quite simple
    • Cons: The new content is not exactly a "Frequently asked question," but instead provides guidance for anyone new to the site

    image
    A mock FAQ page with the new section

  3. A nested submenu - add new page contained in a submenu within a dropdown from the menu bar.

    • Pros: This third option would offer the possibility of the first option, while grouping the new content with the FAQs in a nested menu item titled "Learn." "Help" or "Guides." Avoids redundant top-level navigation items.
    • Cons: Slightly more complex menu structure, necessitating some minor frontend changes that would affect mobile design.

    image
    A mock nested sub-navigation item

Next steps

  • Decide on proper location for new user guide data
  • Set up page/section and appropriate menu items/navigation for new content
  • Implement content management (JSON or elsewhere) for new page

Parent ticket: https://github.com/NASA-IMPACT/ADMG-project/issues/1007

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions