patternfly / patternfly/patternfly-doc-core

Add versioning support for props data gathering and the props API

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

Nobody has claimed this yet.

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

Description

NEEDS REFINEMENT

Currently props data gathering doesn't account for supporting multiple PatternFly versions. We need to add this support and update both the /props route and the hierarchical docs api props routes.


Jira Issue: PF-3468

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 tracing the props data-gathering flow, the /props route, and the hierarchical docs API props routes. Clarify how multiple PatternFly versions should be represented and identify the affected entry points before implementing. Done means version-aware props gathering and updated behavior across both API route forms, with verification in the existing project checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.