Linked / not linked groups

Open
#17 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
react, typescript
Domain
documentation, frontend

Research direction

Reproduce the documentation navigation using the Appbar and Avatar examples in the issue, then locate the implementation of the group headers and their links. Compare linked and non-linked header behavior and determine which interaction should be standardized. Done means users can tell whether a group header opens documentation or collapses a section, with the behavior verified against the reported example.

Written by the indexing model from the issue text.

Description

There's no way to tell which group header is clickable. In this example, you can click on Appbar and it opens the proper docs page, while clicking Avatar makes the section collapse. This makes it harder to just go through the docs.

It could either have some visual indication or maybe open the first sublink by default?

Other than that, great work with the recent changes. It really improved visually 👍

screen shot 2019-03-01 at 20 19 34
Dominant language
TypeScript
Stars
141
Forks
12
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from callstack/component-docs

All issues in callstack/component-docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.