patternfly / patternfly/patternfly-doc-core

The ExampleToolbar.tsx file and ast-helpers dependency should be removed

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

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
2
Forks
11
Avg merge
5d 15h
Merged PRs (30d)
1

Description

Followup to #49

The implementation in that PR relies on the ExampleToolbar from the docs framework to render the code editor, and helpers from the ast-helpers package should either be properly typed and tested, or we should come up with a new tested and typed solution.


Jira Issue: PF-2090

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.

Research direction

Start by locating ExampleToolbar.tsx and the ast-helpers usage introduced by #49. Determine whether the helpers can be properly typed and tested or need a new solution; done means the toolbar file and dependency are removed and the replacement approach is typed and tested.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.