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

feat(dgeni,daffio): render package API doc exports #2991

Merged

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Aug 16, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #2816, fixes: #2971

What is the new behavior?

  • generates package docs as JSON
  • handles API package docs specially in the doc viewer
  • extracts the API list children to a separate component for use with API package docs

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@griest024 griest024 added 🚨 breaking changes This PR or issue will cause a breaking change tools: dgeni @daffodil/tools-dgeni labels Aug 16, 2024
@griest024 griest024 requested a review from a team as a code owner August 16, 2024 16:05
@griest024 griest024 requested review from a team as code owners August 16, 2024 19:26
@griest024 griest024 added the status: awaiting review This PR is awaiting review label Aug 16, 2024
@griest024 griest024 changed the title feat(dgeni)!: add exports to package API docs feat(dgeni): add exports to package API docs Aug 16, 2024
@griest024 griest024 changed the title feat(dgeni): add exports to package API docs feat(dgeni,daffio): render package API doc exports Aug 16, 2024
@griest024 griest024 added package: daff.io @daffodil/daff.io and removed 🚨 breaking changes This PR or issue will cause a breaking change labels Aug 16, 2024
@xelaint
Copy link
Member

xelaint commented Aug 21, 2024

@griest024 I also need to make updates to the UI of list items in the api list. LMK when I can do that.

@griest024
Copy link
Member Author

@xelaint you can go ahead and make UI updates

@xelaint xelaint force-pushed the feat/dgeni/api-package-contents branch from 72cdc25 to 34890c6 Compare August 21, 2024 19:03
@xelaint
Copy link
Member

xelaint commented Aug 21, 2024

Screen Shot 2024-08-21 at 3 05 53 PM

@griest024 Is there a way to pull this section of the readme and add it to the page?

@griest024
Copy link
Member Author

Screen Shot 2024-08-21 at 3 05 53 PM @griest024 Is there a way to pull this section of the readme and add it to the page?

hm yeah, technically. I think this is better pulled from the package.json description field.

@griest024 griest024 merged commit c3131d8 into graycoreio:develop Aug 22, 2024
10 checks passed
@gray-bot gray-bot mentioned this pull request Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: daff.io @daffodil/daff.io status: awaiting review This PR is awaiting review tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] Set up main API page for each package [BUG] Daffodil Package API page missing child symbols
2 participants