Initial commit
This commit is contained in:
105
docs/README.md
Normal file
105
docs/README.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Vuer UIKit Documentation
|
||||
|
||||
This directory contains the complete documentation for Vuer UIKit, fetched from https://uikit.vuer.ai/
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
### Guides (2/2 complete)
|
||||
- [Introduction](guides/introduction.md) - Overview and quick start
|
||||
- [Getting Started](guides/getting-started.md) - Installation and setup
|
||||
|
||||
### Style Guide (4/4 complete)
|
||||
- [Colors](style-guide/colors.md) - Color system and variables
|
||||
- [Font](style-guide/font.md) - Typography scale
|
||||
- [Icons](style-guide/icons.md) - Icon system using Lucide
|
||||
- [Layout](style-guide/layout.md) - Spacing and border radius
|
||||
|
||||
### Form Inputs (4/4 complete)
|
||||
- [Input](form-inputs/input.md) - Basic input component
|
||||
- [Number Inputs](form-inputs/number-inputs.md) - Numeric inputs with drag functionality
|
||||
- [Playground](form-inputs/playground.md) - Interactive playground
|
||||
- [Specialized Inputs](form-inputs/specialized-inputs.md) - Unit-specific inputs (cm, rad, vector3, etc.)
|
||||
|
||||
### Dial System (2/9 fetched)
|
||||
- [Overview](dial/overview.md) - Dial system introduction
|
||||
- [Getting Started](dial/getting-started.md) - Installation and basic workflow
|
||||
- Tutorial - *Fetched, needs saving*
|
||||
- Input Types - *Fetched, needs saving*
|
||||
- Type Inheritance - *Fetched, needs saving*
|
||||
- CLI Reference - *Fetched, needs saving*
|
||||
- Testing - *Fetched, needs saving*
|
||||
- Controlled Dials - *Fetched, needs saving*
|
||||
- API Notes - *Fetched, needs saving*
|
||||
|
||||
### Menu Tool Layouts (0/3 - fetched, needs saving)
|
||||
- Dock Layout - *Fetched, needs saving*
|
||||
- Liquid Float Layout - *Fetched, needs saving*
|
||||
- Toolbar - *Fetched, needs saving*
|
||||
|
||||
### Components (3/38 - 3 fetched, 35 remaining)
|
||||
#### Fetched (needs saving):
|
||||
- Avatar - *Fetched, needs saving*
|
||||
- Badge - *Fetched, needs saving*
|
||||
- Button - *Fetched, needs saving*
|
||||
|
||||
#### Remaining to fetch (35 components):
|
||||
- Card
|
||||
- Checkbox
|
||||
- Collapsible
|
||||
- Cursor Display
|
||||
- Drag Selectable
|
||||
- Drawer
|
||||
- Dropdown
|
||||
- Layout
|
||||
- Modal
|
||||
- Navbar
|
||||
- Navigation
|
||||
- Pagination
|
||||
- Popover
|
||||
- Preview
|
||||
- Progress
|
||||
- Radio Group
|
||||
- Select
|
||||
- Sheet
|
||||
- Sidebar
|
||||
- Simple Tree View
|
||||
- Slider
|
||||
- Spinner
|
||||
- Switch
|
||||
- Sync Scroll
|
||||
- Table
|
||||
- Tabs
|
||||
- Textarea
|
||||
- Toast
|
||||
- Toggle
|
||||
- Toggle Buttons
|
||||
- Toggle Group
|
||||
- Tooltip
|
||||
- Tree View
|
||||
- Version Badge
|
||||
- Waterfall
|
||||
|
||||
### Other (1/2 complete)
|
||||
- [Hooks](other/hooks.md) - React hooks documentation
|
||||
- Test Codeblock - *Fetched, needs saving*
|
||||
|
||||
## Fetch Status Summary
|
||||
|
||||
**Completed and Saved:** 15 pages
|
||||
**Fetched (needs saving):** 14 pages
|
||||
**Remaining to fetch:** 35 pages
|
||||
**Total:** 64 pages
|
||||
|
||||
## Next Steps
|
||||
|
||||
To complete the documentation:
|
||||
|
||||
1. Save the 14 already-fetched pages (see list above)
|
||||
2. Fetch the remaining 35 component pages
|
||||
3. Verify all links and cross-references
|
||||
|
||||
## Source
|
||||
|
||||
All documentation fetched from: https://uikit.vuer.ai/
|
||||
Version: v0.0.117
|
||||
Dial CLI Version: v0.0.22
|
||||
Reference in New Issue
Block a user