Skip to content

Commit 4a24d00

Browse files
Copilothotlong
andcommitted
docs: rename documentation files to lowercase
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 25aacc3 commit 4a24d00

7 files changed

Lines changed: 26 additions & 26 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,8 +424,8 @@ We welcome contributions! Please read our [Contributing Guide](./CONTRIBUTING.md
424424
425425
### For Developers
426426
427-
- 📖 [Quick Start for Developers](./docs/QUICK_START_DEV.md) - Get started in 5 minutes
428-
- 📋 [Development Plan](./docs/DEVELOPMENT_PLAN.md) - Current priorities and roadmap
427+
- 📖 [Quick Start for Developers](./docs/quick-start-dev.md) - Get started in 5 minutes
428+
- 📋 [Development Plan](./docs/development-plan.md) - Current priorities and roadmap
429429
430430
### Development Setup
431431

docs/.vitepress/config.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ export default defineConfig({
4949
{
5050
text: 'Development',
5151
items: [
52-
{ text: 'Quick Start for Developers', link: '/QUICK_START_DEV' },
53-
{ text: 'Development Plan', link: '/DEVELOPMENT_PLAN' },
52+
{ text: 'Quick Start for Developers', link: '/quick-start-dev' },
53+
{ text: 'Development Plan', link: '/development-plan' },
5454
{ text: 'Contributing Guide', link: '/CONTRIBUTING' }
5555
]
5656
},

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This directory contains the VitePress documentation site for Object UI.
1313
- 🗺️ [Roadmap](./ROADMAP.md)
1414

1515
### For Developers
16-
-[Quick Start for Developers](./QUICK_START_DEV.md) - Get started in 5 minutes
17-
- 📋 [Development Plan](./DEVELOPMENT_PLAN.md) - Q1-Q2 2026 priorities and roadmap
16+
-[Quick Start for Developers](./quick-start-dev.md) - Get started in 5 minutes
17+
- 📋 [Development Plan](./development-plan.md) - Q1-Q2 2026 priorities and roadmap
1818
- 🤝 [Contributing Guide](../CONTRIBUTING.md) - How to contribute
1919
- 📚 [Best Practices](./BEST_PRACTICES.md) - Code quality guidelines
2020

File renamed without changes.
Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This PR delivers comprehensive development planning and documentation to guide t
1919
## 📦 What Was Created
2020

2121
### 1. Development Plan
22-
**File**: `docs/DEVELOPMENT_PLAN.md` (21KB)
22+
**File**: `docs/development-plan.md` (21KB)
2323

2424
Complete Q1-Q2 2026 development roadmap including:
2525
- Current project status
@@ -32,7 +32,7 @@ Complete Q1-Q2 2026 development roadmap including:
3232
- Success metrics
3333

3434
### 2. Quick Start for Developers
35-
**File**: `docs/QUICK_START_DEV.md` (4.2KB)
35+
**File**: `docs/quick-start-dev.md` (4.2KB)
3636

3737
Fast-track guide for new developers featuring:
3838
- 5-minute setup instructions
@@ -42,7 +42,7 @@ Fast-track guide for new developers featuring:
4242
- Links to detailed documentation
4343

4444
### 3. Project Status Summary
45-
**File**: `docs/PROJECT_STATUS.md` (11KB)
45+
**File**: `docs/project-status.md` (11KB)
4646

4747
Current state of the ObjectUI project including:
4848
- Executive summary
@@ -78,8 +78,8 @@ Added new "Development" section to sidebar:
7878
{
7979
text: 'Development',
8080
items: [
81-
{ text: 'Quick Start for Developers', link: '/QUICK_START_DEV' },
82-
{ text: 'Development Plan', link: '/DEVELOPMENT_PLAN' },
81+
{ text: 'Quick Start for Developers', link: '/quick-start-dev' },
82+
{ text: 'Development Plan', link: '/development-plan' },
8383
{ text: 'Contributing Guide', link: '/CONTRIBUTING' }
8484
]
8585
}
@@ -149,10 +149,10 @@ Added "For Developers" quick links section with all new documentation.
149149

150150
```
151151
docs/
152-
├── DEVELOPMENT_PLAN.md # Development plan (NEW)
153-
├── QUICK_START_DEV.md # Developer quick start (NEW)
154-
├── PROJECT_STATUS.md # Project status summary (NEW)
155-
├── PR_DOCUMENTATION_SUMMARY.md # This PR summary (NEW)
152+
├── development-plan.md # Development plan (NEW)
153+
├── quick-start-dev.md # Developer quick start (NEW)
154+
├── project-status.md # Project status summary (NEW)
155+
├── pr-documentation-summary.md # This PR summary (NEW)
156156
├── ROADMAP.md # Product roadmap (existing)
157157
├── CONTRIBUTING.md # Contributing guide (existing)
158158
├── guide/ # User guides
@@ -253,7 +253,7 @@ docs/
253253

254254
### Short Term (Next 2 Weeks)
255255
1. ⏳ Complete Phase 1 (Core Enhancement)
256-
2. ⏳ Update progress in PROJECT_STATUS.md
256+
2. ⏳ Update progress in project-status.md
257257
3. ⏳ Collect feedback from contributors
258258
4. ⏳ Refine timeline based on progress
259259

@@ -343,8 +343,8 @@ Focus on making contribution easy:
343343

344344
### Living Documents
345345
These documents will be updated:
346-
- **Weekly**: PROJECT_STATUS.md (progress tracking)
347-
- **Bi-weekly**: DEVELOPMENT_PLAN.md (timeline adjustments)
346+
- **Weekly**: project-status.md (progress tracking)
347+
- **Bi-weekly**: development-plan.md (timeline adjustments)
348348
- **Monthly**: ROADMAP.md (strategic updates)
349349

350350
---
@@ -381,6 +381,6 @@ Special thanks to:
381381

382382
**Let's build ObjectUI v1.0.0 together!** 🚀
383383

384-
[View Development Plan](./DEVELOPMENT_PLAN.md) | [Quick Start](./QUICK_START_DEV.md) | [Project Status](./PROJECT_STATUS.md)
384+
[View Development Plan](./development-plan.md) | [Quick Start](./quick-start-dev.md) | [Project Status](./project-status.md)
385385

386386
</div>
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,9 @@ plugins/* (depends: components, react)
294294
## 🎓 Resources for New Contributors
295295

296296
### Getting Started
297-
1. **[Quick Start for Developers](./docs/QUICK_START_DEV.md)** - 5-minute setup
298-
2. **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute
299-
3. **[Development Plan](./docs/DEVELOPMENT_PLAN.md)** - Current priorities
297+
1. **[Quick Start for Developers](./quick-start-dev.md)** - 5-minute setup
298+
2. **[Contributing Guide](../CONTRIBUTING.md)** - How to contribute
299+
3. **[Development Plan](./development-plan.md)** - Current priorities
300300

301301
### Technical Docs
302302
4. **[Architecture](./docs/spec/architecture.md)** - System design
@@ -320,7 +320,7 @@ We need help in these areas:
320320
- Add test cases
321321

322322
### ✨ Feature Development
323-
- Pick tasks from [Development Plan](./docs/DEVELOPMENT_PLAN.md)
323+
- Pick tasks from [Development Plan](./development-plan.md)
324324
- Build new components
325325
- Enhance existing features
326326

@@ -402,6 +402,6 @@ We need help in these areas:
402402

403403
**Let's build the future of Schema-Driven UI together!** 🚀
404404

405-
[View Development Plan](./docs/DEVELOPMENT_PLAN.md) | [Quick Start](./docs/QUICK_START_DEV.md) | [Contributing](./CONTRIBUTING.md)
405+
[View Development Plan](./development-plan.md) | [Quick Start](./quick-start-dev.md) | [Contributing](../CONTRIBUTING.md)
406406

407407
</div>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ objectui/
195195
### Documentation
196196
- [Architecture](./spec/architecture.md) - System design overview
197197
- [Contributing Guide](../CONTRIBUTING.md) - Detailed contribution guide
198-
- [Development Plan](./DEVELOPMENT_PLAN.md) - Roadmap and priorities
198+
- [Development Plan](./development-plan.md) - Roadmap and priorities
199199

200200
### Communication
201201
- **GitHub Issues** - Bug reports and features
@@ -208,7 +208,7 @@ objectui/
208208

209209
1.**Explore the Showcase** - See what's possible
210210
2.**Read the Architecture** - Understand the design
211-
3.**Pick a Task** - Check [Development Plan](./DEVELOPMENT_PLAN.md)
211+
3.**Pick a Task** - Check [Development Plan](./development-plan.md)
212212
4.**Make Your First PR** - Start contributing!
213213

214214
---

0 commit comments

Comments
 (0)