In-app documentation sample updates

Open
#208 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation, frontend

Research direction

Start by locating the in-app documentation sample described in the Quick Starts “in-app documentation” section and the sample list in “Basic example.” Update the sample to show a “Learn more” link with the pf-icon-open-drawer-right icon, then add the same icon after each listed link and verify both examples match the requested behavior.

Written by the indexing model from the issue text.

Description

documentation

We should provide a sample on the in-app documentation section that shows how a user launches the drawer. In the main window of the UI there will be a "Learn more" link followed by the pf-icon-open-drawer-right icon. When user clicks this link the in-app doc drawer opens. This icon helps the user know they will not be leaving the page and that the additional content will appear in a drawer of their current window.

We should also include this icon after each link on the sample list here for consistency.

Jira Issue: PF-1886

Dominant language
TypeScript
Stars
15
Forks
47
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 patternfly/patternfly-quickstarts

All issues in patternfly/patternfly-quickstarts

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.