patternfly / patternfly/patternfly-org
Docs-core delivery of new PF documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
This epic focuses on utilizing the astro-based docs-core infrastructure to continue enhancing PatternFly's documentation.
In Q4, we are going to:
-
leverage the astro framework to build out agent friendly documentation as text files.
-
leverage the astro framework to deliver a Rest API for fetching component props to enable JSON schema validation of PF component definitions.
-
Investigate the power of astro to reconstruct the PF component documentation and resolve questions of:
-
performance
-
server side validation
-
inline live component examples
-
full page demos/examples
-
Determine if this framework is capable of fully replacing the PatternFly documentation-framework for building patternfly.org.
Jira Issue: PF-2190
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Astro-based docs-core infrastructure and how it relates to the existing PatternFly documentation framework. The issue is done only when the planned documentation, props REST API, validation, examples, performance, and replacement questions have been resolved, but it does not identify files, tests, or a bounded first task.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100