Skip to content

Conversation

MajesticPotatoe
Copy link
Member

Adds missing component pages

ToDo

  • Needs to be checked for accuracy

@MajesticPotatoe MajesticPotatoe added the documentation Improvements or additions to documentation label Aug 6, 2025
Copy link

vercel bot commented Aug 6, 2025

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

Name Status Preview Comments Updated (UTC)
vuetify0 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2025 4:09pm

@johnleider
Copy link
Member

johnleider commented Aug 7, 2025

I've held off on these simply because they are based off of composables which have been in flux. We can use this as an opportunity to explore page structure so we can maybe put together a few .md templates that solve the scenarios:

  • I want to add a new component, what docs does it need?
  • I want to add a new composable, what docs does it need?

@MajesticPotatoe
Copy link
Member Author

I've held off on these simply because they are based off of composables which have been in flux. We can use this as an opportunity to explore page structure so we can maybe put together a few .md templates that solve the scenarios:

All good, i just saw bare pages, and thought, well get something on it at least.

My thoughts on minimum component structure:

#Component
Description / details / structure breakdown

## API
## Examples
Interactive Usage Example (like we got in main docs maybe, that showcases the props/slots/events + output)

-- examples should outline at min, one fore each prop/slot/event group as applicable)
### Props
### Slots
### Events

Composable pretty much follow a simpler structure (at least as a starting point)

#Composable
Description / details

## API
## Examples
-- examples of each exported function and its use

@johnleider
Copy link
Member

Add # Usage and I think that's good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants