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

Auto-Doc Generation #2617

Closed
wants to merge 2 commits into from
Closed

Auto-Doc Generation #2617

wants to merge 2 commits into from

Conversation

endigo9740
Copy link
Contributor

Linked Issue

Closes #2399

Description

Implements a means to parse Typescript to JSON schema for displaying props for each framework component.

@endigo9740 endigo9740 linked an issue Apr 12, 2024 that may be closed by this pull request
12 tasks
Copy link

changeset-bot bot commented Apr 12, 2024

⚠️ No Changeset found

Latest commit: 8ed2964

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Apr 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
skeleton-next 🔄 Building (Inspect) Visit Preview Apr 12, 2024 9:02pm
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
skeleton-docs ⬜️ Ignored (Inspect) Visit Preview Apr 12, 2024 9:02pm
skeleton-themes ⬜️ Ignored (Inspect) Visit Preview Apr 12, 2024 9:02pm

@endigo9740 endigo9740 changed the title NEXT Docs - Auto-Doc API Generation Auto-Doc API Generation Apr 12, 2024
@endigo9740 endigo9740 marked this pull request as draft April 12, 2024 22:19
@endigo9740 endigo9740 changed the title Auto-Doc API Generation Auto-Doc Generation Apr 24, 2024
@endigo9740
Copy link
Contributor Author

endigo9740 commented May 13, 2024

This was a great test, but I think we should limit the generation of the type scheme to each package. Either via a manual or automated generation process. This will keep things local and "baked into" each package. The generated files should then be exported for consumption in the Astro doc site.

@endigo9740 endigo9740 closed this May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NEXT: Automated Documentation
1 participant