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.

Sign up for GitHub

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

Jump to bottom

[FEAT] Render API usage examples in a separate tab #3390

Open
griest024 opened this issue Jan 3, 2025 · 7 comments
Open

[FEAT] Render API usage examples in a separate tab #3390

griest024 opened this issue Jan 3, 2025 · 7 comments
Assignees
@griest024
Labels
feat a new feature, enhancement, or improvement package: daff.io @daffodil/daff.io

Comments

@griest024
Copy link
Member

No description provided.

@griest024 griest024 added feat a new feature, enhancement, or improvement package: daff.io @daffodil/daff.io labels Jan 3, 2025
@griest024 griest024 self-assigned this Jan 3, 2025
@griest024
Copy link
Member Author

blocked by #3388

@xelaint
Copy link
Member

xelaint commented Jan 3, 2025

@griest024 this is only relevant for the @daffodil/design package.

How will the examples be added into the Usage tab, that's currently just rendering the markdown files of each component?

@griest024
Copy link
Member Author

They can be rendered however you want, I just figured a separate examples tab made sense. It can just be a section below if you think that's better.

@griest024
Copy link
Member Author

I'm going to change the doc viewer component to be more flexible beyond just dumbly rendering whatever is in the content field. We will need that flexibility to implement #3377 (comment)

This was referenced Jan 7, 2025
Merged
Merged
Draft
@griest024
Copy link
Member Author

Connect route query parms to active tab

@xelaint
Copy link
Member

xelaint commented Jan 9, 2025

After discussion, all API docs will have Usage tab.

@griest024
Copy link
Member Author

blocked by #3408

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@griest024 griest024

Labels
feat a new feature, enhancement, or improvement package: daff.io @daffodil/daff.io
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@griest024 @xelaint