Skip to content

Commit 14655be

Browse files
puikinshclaude
andcommitted
Improve documentation structure and fix broken links
- Fixed all broken internal links in documentation files - Simplified features.md to focus on actual template capabilities - Updated SUMMARY.md for proper GitBook navigation - Removed irrelevant/theoretical content from documentation - Ensured all links point to existing files - Organized documentation for better GitBook compatibility 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a1b27f2 commit 14655be

8 files changed

Lines changed: 260 additions & 976 deletions

File tree

docs/README.md

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,76 @@
1-
# Metis Bootstrap 5 Admin Template
1+
# Metis - Bootstrap 5 Admin Template Documentation
22

33
A modern, responsive admin dashboard template built with Bootstrap 5.3.7, featuring dark/light themes, Alpine.js reactivity, and comprehensive UI components.
44

5-
## Quick Links
5+
## Quick Navigation
66

77
- [Getting Started](getting-started/welcome.md)
88
- [Installation Guide](getting-started/installation.md)
9-
- [Template Overview](overview/features.md)
10-
- [Components](components/elements.md)
11-
- [Customization](customization/theming.md)
12-
- [API Reference](reference/api.md)
9+
- [Quick Start](getting-started/quick-start.md)
10+
- [Template Overview](overview/introduction.md)
11+
- [Features](overview/features.md)
1312

14-
## Features at a Glance
13+
## About This Template
1514

16-
- **Modern Stack**: Bootstrap 5.3.7, Alpine.js, Vite
17-
- **Responsive Design**: Mobile-first approach
18-
- **Dark/Light Themes**: Persistent theme switching
19-
- **PWA Ready**: Progressive Web App support
20-
- **Rich Components**: 21 pages, 8 UI element showcases
21-
- **Performance**: Optimized builds and lazy loading
22-
- **Developer Friendly**: Clean code, ES6+ modules
15+
Metis is a modern Bootstrap 5 admin dashboard template that provides:
2316

24-
## Getting Started
17+
- **Modern Technology Stack**: Bootstrap 5.3.7, Alpine.js, Vite, SCSS
18+
- **Responsive Design**: Mobile-first approach with clean, modern UI
19+
- **Dark/Light Themes**: Persistent theme switching with smooth transitions
20+
- **Rich Dashboard Pages**: 15+ pre-built pages including analytics, user management, and more
21+
- **Developer Experience**: Hot reload, component architecture, modern build pipeline
22+
23+
## Template Structure
24+
25+
```
26+
src-modern/ # Main template files
27+
├── assets/ # Static assets (icons, images)
28+
├── scripts/ # JavaScript modules
29+
├── styles/scss/ # SCSS stylesheets
30+
├── index.html # Main dashboard
31+
├── analytics.html # Analytics dashboard
32+
├── users.html # User management
33+
├── products.html # Product management
34+
├── orders.html # Order management
35+
├── messages.html # Messaging interface
36+
├── calendar.html # Calendar page
37+
├── files.html # File manager
38+
├── reports.html # Reports dashboard
39+
├── settings.html # Settings page
40+
├── security.html # Security settings
41+
├── help.html # Help & support
42+
└── elements*.html # UI element examples
43+
```
44+
45+
## Quick Start
2546

2647
```bash
27-
# Clone or download the template
48+
# Clone the repository
2849
git clone https://github.com/puikinsh/Bootstrap-Admin-Template.git
2950

3051
# Navigate to the project
31-
cd Bootstrap-Admin-Template/src-modern
52+
cd Bootstrap-Admin-Template
3253

33-
# Install dependencies (if using npm)
54+
# Install dependencies
3455
npm install
3556

3657
# Start development server
3758
npm run dev
3859
```
3960

61+
Visit `http://localhost:3000` to see the template in action.
62+
4063
## Browser Support
4164

42-
- Chrome (latest)
43-
- Firefox (latest)
44-
- Safari (latest)
45-
- Edge (latest)
46-
- Mobile browsers (iOS Safari, Chrome Mobile)
65+
- Chrome 90+
66+
- Firefox 88+
67+
- Safari 14+
68+
- Edge 90+
69+
- Mobile browsers (iOS Safari 14+, Chrome Mobile 90+)
4770

4871
## License
4972

50-
This template is released under the MIT License. See [LICENSE](LICENSE) for details.
73+
This template is released under the MIT License. See [LICENSE.md](../LICENSE.md) for details.
5174

5275
---
5376

docs/SUMMARY.md

Lines changed: 8 additions & 217 deletions
Original file line numberDiff line numberDiff line change
@@ -1,224 +1,15 @@
11
# Summary
22

3+
## Overview
4+
* [Introduction](README.md)
5+
36
## Getting Started
4-
* [Welcome to Metis](getting-started/welcome.md)
5-
* [Quick Start Guide](getting-started/quick-start.md)
6-
* [System Requirements](getting-started/requirements.md)
7+
* [Welcome](getting-started/welcome.md)
8+
* [Requirements](getting-started/requirements.md)
79
* [Installation](getting-started/installation.md)
10+
* [Quick Start](getting-started/quick-start.md)
811
* [First Run](getting-started/first-run.md)
912

1013
## Template Overview
11-
* [What is Metis?](overview/introduction.md)
12-
* [Key Features](overview/features.md)
13-
* [Template Structure](overview/structure.md)
14-
* [Browser Support](overview/browser-support.md)
15-
* [Live Demo](overview/demo.md)
16-
17-
## Architecture & Technical Stack
18-
* [Core Technologies](architecture/technologies.md)
19-
* [JavaScript Architecture](architecture/javascript.md)
20-
* [CSS/SCSS Structure](architecture/scss.md)
21-
* [Build System](architecture/build.md)
22-
* [Icon Systems](architecture/icons.md)
23-
* [PWA Support](architecture/pwa.md)
24-
25-
## Layout & Navigation
26-
* [Layout System](layout/layout-system.md)
27-
* [Navigation Components](layout/navigation.md)
28-
* [Responsive Design](layout/responsive.md)
29-
* [Sidebar Management](layout/sidebar.md)
30-
* [Breadcrumbs](layout/breadcrumbs.md)
31-
* [Mobile Navigation](layout/mobile.md)
32-
33-
## Pages & Components
34-
35-
### Dashboard Pages
36-
* [Main Dashboard](pages/dashboard/main.md)
37-
* [Analytics Dashboard](pages/dashboard/analytics.md)
38-
39-
### Management Pages
40-
* [User Management](pages/management/users.md)
41-
* [Product Management](pages/management/products.md)
42-
* [Order Management](pages/management/orders.md)
43-
* [File Management](pages/management/files.md)
44-
45-
### Communication
46-
* [Messages](pages/communication/messages.md)
47-
* [Calendar](pages/communication/calendar.md)
48-
49-
### Configuration
50-
* [Settings](pages/configuration/settings.md)
51-
* [Security](pages/configuration/security.md)
52-
* [Help & Support](pages/configuration/help.md)
53-
54-
## UI Components
55-
56-
### Elements Showcase
57-
* [Component Overview](components/overview.md)
58-
* [Buttons](components/buttons.md)
59-
* [Alerts](components/alerts.md)
60-
* [Badges](components/badges.md)
61-
* [Cards](components/cards.md)
62-
* [Modals](components/modals.md)
63-
* [Forms](components/forms.md)
64-
* [Tables](components/tables.md)
65-
66-
### Advanced Components
67-
* [Charts & Graphs](components/charts.md)
68-
* [Form Validation](components/validation.md)
69-
* [File Upload](components/upload.md)
70-
* [Toast Notifications](components/notifications.md)
71-
* [Search](components/search.md)
72-
73-
## Theming & Customization
74-
75-
### Theme System
76-
* [Dark/Light Themes](theming/themes.md)
77-
* [Color Palette](theming/colors.md)
78-
* [Typography](theming/typography.md)
79-
* [Spacing System](theming/spacing.md)
80-
* [Border Radius](theming/borders.md)
81-
82-
### Customization Guide
83-
* [SCSS Variables](customization/variables.md)
84-
* [CSS Custom Properties](customization/properties.md)
85-
* [Component Styling](customization/components.md)
86-
* [Logo & Branding](customization/branding.md)
87-
* [Layout Modifications](customization/layout.md)
88-
89-
## JavaScript & Interactivity
90-
91-
### Core JavaScript
92-
* [Alpine.js Integration](javascript/alpine.md)
93-
* [Event Handling](javascript/events.md)
94-
* [Data Management](javascript/data.md)
95-
* [API Integration](javascript/api.md)
96-
* [Performance Optimization](javascript/performance.md)
97-
98-
### Component-Specific JS
99-
* [Dashboard Scripts](javascript/dashboard.md)
100-
* [Form Validation](javascript/forms.md)
101-
* [User Management](javascript/users.md)
102-
* [File Operations](javascript/files.md)
103-
* [Search Functionality](javascript/search.md)
104-
105-
## Advanced Features
106-
107-
### Progressive Web App
108-
* [PWA Configuration](advanced/pwa-config.md)
109-
* [Offline Support](advanced/offline.md)
110-
* [Installation](advanced/installation.md)
111-
* [Push Notifications](advanced/notifications.md)
112-
113-
### Performance
114-
* [Optimization Techniques](advanced/optimization.md)
115-
* [Bundle Analysis](advanced/bundle.md)
116-
* [Loading States](advanced/loading.md)
117-
* [Caching Strategies](advanced/caching.md)
118-
119-
## Development Guide
120-
121-
### Development Workflow
122-
* [Local Development](development/local.md)
123-
* [Build Process](development/build.md)
124-
* [Hot Reloading](development/hot-reload.md)
125-
* [Debugging](development/debugging.md)
126-
* [Testing](development/testing.md)
127-
128-
### Code Organization
129-
* [File Structure](development/structure.md)
130-
* [Naming Conventions](development/naming.md)
131-
* [Module System](development/modules.md)
132-
* [SCSS Architecture](development/scss.md)
133-
* [Component Creation](development/components.md)
134-
135-
## Deployment & Production
136-
137-
### Build & Deployment
138-
* [Production Build](deployment/build.md)
139-
* [Deployment Options](deployment/options.md)
140-
* [Environment Configuration](deployment/environment.md)
141-
* [Asset Optimization](deployment/assets.md)
142-
* [Performance Monitoring](deployment/monitoring.md)
143-
144-
### Maintenance
145-
* [Updates](deployment/updates.md)
146-
* [Security](deployment/security.md)
147-
* [Backup](deployment/backup.md)
148-
* [Monitoring](deployment/monitoring.md)
149-
150-
## API Integration
151-
152-
### Data Sources
153-
* [REST API](api/rest.md)
154-
* [GraphQL](api/graphql.md)
155-
* [WebSocket](api/websocket.md)
156-
* [Authentication](api/auth.md)
157-
* [Error Handling](api/errors.md)
158-
159-
### Example Implementations
160-
* [User Authentication](api/examples/auth.md)
161-
* [Data Tables](api/examples/tables.md)
162-
* [File Upload](api/examples/upload.md)
163-
* [Real-time Updates](api/examples/realtime.md)
164-
165-
## Migration & Upgrading
166-
167-
### Version Migration
168-
* [Upgrading Bootstrap](migration/bootstrap.md)
169-
* [Dependency Updates](migration/dependencies.md)
170-
* [Breaking Changes](migration/breaking.md)
171-
* [Legacy Support](migration/legacy.md)
172-
173-
### From Other Templates
174-
* [Migration Guide](migration/guide.md)
175-
* [Component Mapping](migration/mapping.md)
176-
* [Data Migration](migration/data.md)
177-
* [Testing](migration/testing.md)
178-
179-
## Troubleshooting
180-
181-
### Common Issues
182-
* [Installation Problems](troubleshooting/installation.md)
183-
* [Build Errors](troubleshooting/build.md)
184-
* [Styling Issues](troubleshooting/styling.md)
185-
* [JavaScript Errors](troubleshooting/javascript.md)
186-
* [Performance Issues](troubleshooting/performance.md)
187-
188-
### FAQ
189-
* [Frequently Asked Questions](troubleshooting/faq.md)
190-
* [Best Practices](troubleshooting/best-practices.md)
191-
* [Known Limitations](troubleshooting/limitations.md)
192-
* [Workarounds](troubleshooting/workarounds.md)
193-
194-
## Examples & Tutorials
195-
196-
### Step-by-Step Guides
197-
* [Creating Your First Page](examples/first-page.md)
198-
* [Adding New Components](examples/components.md)
199-
* [Theming Tutorial](examples/theming.md)
200-
* [API Integration](examples/api.md)
201-
* [Advanced Customization](examples/advanced.md)
202-
203-
### Code Examples
204-
* [Component Usage](examples/code/components.md)
205-
* [JavaScript Patterns](examples/code/javascript.md)
206-
* [SCSS Techniques](examples/code/scss.md)
207-
* [Performance Optimization](examples/code/performance.md)
208-
* [Security Implementation](examples/code/security.md)
209-
210-
## Reference
211-
212-
### API Reference
213-
* [JavaScript API](reference/javascript.md)
214-
* [SCSS Variables](reference/variables.md)
215-
* [CSS Classes](reference/classes.md)
216-
* [Component Props](reference/props.md)
217-
* [Event Handlers](reference/events.md)
218-
219-
### Resources
220-
* [Changelog](reference/changelog.md)
221-
* [Browser Support](reference/browser-support.md)
222-
* [Dependencies](reference/dependencies.md)
223-
* [License](reference/license.md)
224-
* [Contributing](reference/contributing.md)
14+
* [Introduction](overview/introduction.md)
15+
* [Features](overview/features.md)

docs/getting-started/first-run.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -331,23 +331,23 @@ Chart.register(CategoryScale, LinearScale, BarElement);
331331
After completing your first run:
332332
333333
### Immediate Actions
334-
1. **[Template Structure](../overview/structure.md)** - Understand the codebase
335-
2. **[Customization Guide](../customization/branding.md)** - Make it your own
336-
3. **[Development Setup](../development/local.md)** - Advanced development
334+
1. **[Template Overview](../overview/introduction.md)** - Understand the template
335+
2. **[Features Overview](../overview/features.md)** - Explore available features
336+
3. **[Quick Start Guide](quick-start.md)** - Get started quickly
337337
338338
### Long-term Planning
339-
1. **[Architecture Overview](../overview/architecture.md)** - Technical deep dive
340-
2. **[Component Library](../components/overview.md)** - Available components
341-
3. **[Integration Guide](../integration/apis.md)** - Connect your backend
339+
1. **[Requirements Guide](requirements.md)** - Technical requirements
340+
2. **[Installation Guide](installation.md)** - Complete setup process
341+
3. **[Template Features](../overview/features.md)** - Explore all capabilities
342342
343343
## Getting Help
344344
345345
If you encounter issues during your first run:
346346
347347
### Documentation
348-
- **[Troubleshooting](../troubleshooting/common-issues.md)** - Common problems and solutions
349-
- **[FAQ](../troubleshooting/faq.md)** - Frequently asked questions
350-
- **[Browser Support](../overview/browser-support.md)** - Compatibility information
348+
- **[Installation Guide](installation.md)** - Complete setup instructions
349+
- **[Requirements](requirements.md)** - System requirements and compatibility
350+
- **[Quick Start](quick-start.md)** - Get up and running quickly
351351
352352
### Community Support
353353
- **GitHub Issues** - Report bugs and feature requests
@@ -374,4 +374,4 @@ Before proceeding to customization:
374374
375375
---
376376
377-
**First run complete!** You're now ready to start customizing Metis for your specific needs. Continue to [Template Structure](../overview/structure.md) to understand how the template is organized.
377+
**First run complete!** You're now ready to start customizing Metis for your specific needs. Continue to [Template Overview](../overview/introduction.md) to understand how the template is organized.

docs/getting-started/installation.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -357,18 +357,17 @@ chmod 644 assets/images/*
357357
After successful installation:
358358

359359
1. **[First Run](first-run.md)**: Complete the initial setup
360-
2. **[Template Structure](../overview/structure.md)**: Understand the codebase
361-
3. **[Customization](../customization/branding.md)**: Personalize the template
362-
4. **[Development](../development/local.md)**: Set up development environment
360+
2. **[Features Overview](../overview/features.md)**: Explore template features
361+
3. **[Introduction](../overview/introduction.md)**: Learn about the template architecture
363362

364363
## Getting Help
365364

366365
If you encounter issues during installation:
367366

368367
### Documentation
369368
- **[System Requirements](requirements.md)**: Check prerequisites
370-
- **[Troubleshooting](../troubleshooting/installation.md)**: Common problems
371-
- **[FAQ](../troubleshooting/faq.md)**: Frequently asked questions
369+
- **[Quick Start Guide](quick-start.md)**: Get up and running quickly
370+
- **[Welcome Guide](welcome.md)**: Introduction to the template
372371

373372
### Community Resources
374373
- **GitHub Issues**: Report bugs and get help

0 commit comments

Comments
 (0)