patternfly / patternfly/patternfly-doc-core

Add support for objects in propComponents at the schema level

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

Nobody has claimed this yet.

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

Description

We need to update our markdown schema to allow objects to be passed to our propComponents frontmatter like what we see in our echarts line examples.


Jira Issue: PF-3603

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 the markdown schema that defines propComponents and compare its current shape with the linked PatternFly echarts Line examples. Trace how frontmatter is validated, then verify that object-valued propComponents are accepted without breaking existing examples or schema checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.