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

Docs site supports docs for unstable APIs #2344

Merged
merged 5 commits into from
Nov 18, 2024
Merged

Conversation

r100-stack
Copy link
Member

@r100-stack r100-stack commented Nov 18, 2024

Changes

Moved some unstable API docs related changes from #2001 into this PR. This PR adds an Astro component called UnstableApiCard that is similar to the Placeholder but has a message that is instead the warning for the unstable API.

I thought to replace the info icon with a flask, similar to the experimental API icon in most other docs site. However, I couldn't find a flask icon. So, I used a warning icon for now.

Also, I added a componentProp in PropsTable to help choose the component who's props is to be displayed from the .d.ts file. (#2001 (comment))

Testing

Old screenshot

image

image

Docs

N/A

@r100-stack r100-stack self-assigned this Nov 18, 2024
@r100-stack r100-stack mentioned this pull request Nov 18, 2024
1 task
@r100-stack r100-stack marked this pull request as ready for review November 18, 2024 14:00
@r100-stack r100-stack requested a review from a team as a code owner November 18, 2024 14:00
@r100-stack r100-stack requested review from mayank99 and smmr-dn and removed request for a team November 18, 2024 14:00
apps/website/src/components/DocsNoteCard.astro Outdated Show resolved Hide resolved
apps/website/src/components/UnstableApiCard.astro Outdated Show resolved Hide resolved
@r100-stack r100-stack merged commit 0d9927f into main Nov 18, 2024
17 of 18 checks passed
@r100-stack r100-stack deleted the r/unstable-docs-starter branch November 18, 2024 21:59
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.

3 participants