Skip to content

Commit a46967f

Browse files
Copilothotlong
andcommitted
Fix markdown formatting issues in migration documentation
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent f004dd0 commit a46967f

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

PACKAGE_RESTRUCTURING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,15 @@ packages/
7676
- Thin type re-exports from @objectstack/spec
7777

7878
**Changes:**
79-
```diff
80-
- Remove: Driver interface (use @objectstack/spec)
81-
- Remove: MetadataRegistry types (use @objectstack/runtime)
82-
- Remove: Context types (use @objectstack/runtime)
83-
- Remove: Hook types (use @objectstack/runtime)
84-
- Remove: Action types (use @objectstack/runtime)
85-
+ Add: QueryPlugin interface
86-
+ Add: RepositoryPlugin interface
87-
+ Add: Plugin-specific types
88-
+ Keep: Query-specific helper types
89-
```
79+
- ❌ Remove: Driver interface (use @objectstack/spec)
80+
- ❌ Remove: MetadataRegistry types (use @objectstack/runtime)
81+
- ❌ Remove: Context types (use @objectstack/runtime)
82+
- ❌ Remove: Hook types (use @objectstack/runtime)
83+
- ❌ Remove: Action types (use @objectstack/runtime)
84+
- ✅ Add: QueryPlugin interface
85+
- ✅ Add: RepositoryPlugin interface
86+
- ✅ Add: Plugin-specific types
87+
- ✅ Keep: Query-specific helper types
9088

9189
**Migration Steps:**
9290
1. Create `/packages/core/types/` (new location)

PLUGIN_ARCHITECTURE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document defines the plugin architecture for ObjectQL 4.0, where the reposi
77
## Design Principles
88

99
### 1. Plugin-First Philosophy
10-
**Every feature is a plugin.** Even core query functionality is modular and composable.
10+
**Every feature is a Plugin.** Even core query functionality is modular and composable.
1111

1212
### 2. Clear Separation of Concerns
1313
- **@objectstack/runtime**: Application lifecycle, metadata, security, transactions
@@ -581,13 +581,13 @@ My awesome plugin for ObjectQL.
581581

582582
## Installation
583583

584-
\`\`\`bash
584+
```bash
585585
npm install @objectql/my-plugin
586-
\`\`\`
586+
```
587587

588588
## Usage
589589

590-
\`\`\`typescript
590+
```typescript
591591
import { createRuntime } from '@objectstack/runtime';
592592
import { myPlugin } from '@objectql/my-plugin';
593593

0 commit comments

Comments
 (0)