Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create / Migrate typescript props and function table #116

Open
6 tasks
dlabaj opened this issue Nov 19, 2024 · 0 comments
Open
6 tasks

Create / Migrate typescript props and function table #116

dlabaj opened this issue Nov 19, 2024 · 0 comments

Comments

@dlabaj
Copy link
Contributor

dlabaj commented Nov 19, 2024

Description

Migrate typescript / javascript props and function table generation to patternfly-doc-core so that the markdown parser in Astro can consume the props and function table. This will allow these table to be shown in the generated HTML at the bottom of the page like it is currently being done the documentation framework.

To Do

  • Migrate the function table over,
  • Migrate the props table over
  • Generate the HTML / Markdown for the example markdown documentation page.
  • Add any needed schema to ZOD to support the front matter for Astro's markdown parser.
  • Test and integrate into CI/CD
  • Write any needed unit tests

Definition of done:

  • Typedoc has been migrated over and updated
  • Code integrate, tested, and CI build works

Sign off by stake holders:

  • N/A

Resources:

@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Issues Nov 19, 2024
@dlabaj dlabaj changed the title Migrate typedoc script Create / Migrate typescript props and function table Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Status: Needs triage
Development

No branches or pull requests

1 participant