patternfly / patternfly/patternfly-org

[Document exported helper functions on the website]

Open
#3,215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Is this a new page or a change to an existing one?
New page

Describe the enhancement
patternfly-react current exports some help functions. We would like a way to document those for the consumer.

Any other information?
This is related to the pf react issue #7932

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 reading the patternfly-react issue #7932 and inspect the existing documentation structure on patternfly.org to find where a new page for exported helper functions belongs. Confirm which helper functions are currently exported, then document them on the website and verify the page is discoverable and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.