Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/site/content/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Before you begin, ensure you have:

## Next Steps

Continue to [Installation](/getting-started/installation) to set up your development environment.
Continue to [Installation](./installation.mdx) to set up your development environment.
36 changes: 18 additions & 18 deletions apps/site/content/docs/guide/contributing-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Welcome to the ObjectOS development effort! This guide helps you understand how

## Quick Links

- **[Development Plan (Q1 2026)](./development-plan.md)** - Current quarter's detailed implementation roadmap
- **[Architecture Guide](./architecture.md)** - System design and architectural principles
- **[Security Guide](./security-guide.md)** - Security best practices and guidelines
- **[Development Plan (Q1 2026)](./development-plan.mdx)** - Current quarter's detailed implementation roadmap
- **[Architecture Guide](./architecture.mdx)** - System design and architectural principles
- **[Security Guide](./security-guide.mdx)** - Security best practices and guidelines

## How to Get Involved

Expand All @@ -22,32 +22,32 @@ ObjectOS development is organized into several key areas:
- Object-level permissions (CRUD)
- Field-level security
- Record-level security (RLS)
- See: [Development Plan § 3.1-3.3](./development-plan.md#phase-1-permission-system-implementation-2-3-weeks)
- See: [Development Plan § 3.1-3.3](./development-plan.mdx#phase-1-permission-system-implementation-2-3-weeks)

**🪝 Lifecycle Hooks** (High Priority)
- Standard hooks implementation
- Hook debugging tools
- See: [Development Plan § 3.4-3.5](./development-plan.md#phase-2-lifecycle-hooks-system-1-2-weeks)
- See: [Development Plan § 3.4-3.5](./development-plan.mdx#phase-2-lifecycle-hooks-system-1-2-weeks)

**🔗 Relationship Fields** (High Priority)
- Lookup fields (many-to-one)
- Master-Detail relationships
- Many-to-many relationships
- See: [Development Plan § 3.6-3.8](./development-plan.md#phase-3-relationship-fields-implementation-2-3-weeks)
- See: [Development Plan § 3.6-3.8](./development-plan.mdx#phase-3-relationship-fields-implementation-2-3-weeks)

**🧪 Testing & Quality** (Ongoing)
- Unit tests (target: 90% Kernel, 80% Server, 70% UI)
- Integration tests
- E2E tests
- See: [Development Plan § 3.9-3.11](./development-plan.md#phase-4-testing--documentation-ongoing)
- See: [Development Plan § 3.9-3.11](./development-plan.mdx#phase-4-testing--documentation-ongoing)

### 2. Understand the Standards

Before contributing code, please review:

- **[Architecture Principles](./architecture.md)** - Understand the kernel/driver/server separation
- **[SDK Reference](./sdk-reference.md)** - Learn the ObjectOS API
- **[Contributing Guide](../../CONTRIBUTING.md)** - Code style and workflow
- **[Architecture Principles](./architecture.mdx)** - Understand the kernel/driver/server separation
- **[SDK Reference](./sdk-reference.mdx)** - Learn the ObjectOS API
- **[Contributing Guide](../../../../../CONTRIBUTING.md)** - Code style and workflow

### 3. Set Up Your Environment

Expand All @@ -71,14 +71,14 @@ pnpm run dev

### 4. Pick a Task

Tasks are organized in the [Development Plan](./development-plan.md) with:
Tasks are organized in the [Development Plan](./development-plan.mdx) with:
- **Task Lists** - Specific implementation steps
- **Acceptance Criteria** - What "done" looks like
- **Estimated Time** - How long it should take

Look for:
- Tasks marked as high-priority
- Tasks in the current week (see [Timeline](./development-plan.md#4-timeline--milestones))
- Tasks in the current week (see [Timeline](./development-plan.mdx#4-timeline--milestones))
- Tasks that match your skills and interests

### 5. Submit Your Work
Expand Down Expand Up @@ -146,7 +146,7 @@ All contributions must meet these standards:
- ✅ TypeScript strict mode enabled
- ✅ No `any` types (use `unknown` with guards)
- ✅ All public APIs have JSDoc comments
- ✅ Consistent naming conventions (see [Contributing Guide](../../CONTRIBUTING.md))
- ✅ Consistent naming conventions (see [Contributing Guide](../../../../../CONTRIBUTING.md))

### Test Coverage
- ✅ Kernel: ≥ 90% coverage
Expand Down Expand Up @@ -213,15 +213,15 @@ Implement full relationship support, the most complex feature set.
**Not sure where to start?**
- Look for issues labeled `good first issue`
- Start with documentation improvements
- Review the [Architecture Guide](./architecture.md) to understand the system
- Review the [Architecture Guide](./architecture.mdx) to understand the system

**Stuck on implementation?**
- Check the [Development Plan](./development-plan.md) for code examples
- Review the [SDK Reference](./sdk-reference.md)
- Check the [Development Plan](./development-plan.mdx) for code examples
- Review the [SDK Reference](./sdk-reference.mdx)
- Ask in GitHub Discussions

**Tests failing?**
- Check the [Testing Guide](../../CONTRIBUTING.md#testing)
- Check the [Testing Guide](../../../../../CONTRIBUTING.md#testing)
- Look at existing tests for examples
- Run tests in watch mode: `pnpm test --watch`

Expand All @@ -233,7 +233,7 @@ Implement full relationship support, the most complex feature set.
- Ensure documentation is updated

**Planning next sprint?**
- Review [Timeline & Milestones](./development-plan.md#4-timeline--milestones)
- Review [Timeline & Milestones](./development-plan.mdx#4-timeline--milestones)
- Assess completion status
- Adjust priorities based on progress

Expand Down
6 changes: 3 additions & 3 deletions apps/site/content/docs/guide/data-modeling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,6 @@ curl http://localhost:3000/api/data/contacts/query

## Next Steps

- **[Logic Hooks](./logic-hooks.md)** - Add custom business logic
- **[Security Guide](./security-guide.md)** - Configure permissions
- **[Metadata Format Spec](../spec/metadata-format.md)** - Complete field type reference
- **[Logic Hooks](./logic-hooks.mdx)** - Add custom business logic
- **[Security Guide](./security-guide.mdx)** - Configure permissions
- **[Metadata Format Spec](../spec/metadata-format.mdx)** - Complete field type reference
12 changes: 6 additions & 6 deletions apps/site/content/docs/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -347,11 +347,11 @@ The components automatically:

Now that you have a basic understanding:

1. **[Data Modeling](./data-modeling.md)** - Learn about field types, relationships, and validation
2. **[Architecture Guide](./architecture.md)** - Understand the three-layer architecture
3. **[Security Guide](./security-guide.md)** - Implement authentication and permissions
4. **[Writing Hooks](./logic-hooks.md)** - Add custom business logic
5. **[SDK Reference](./sdk-reference.md)** - Full API documentation
1. **[Data Modeling](./data-modeling.mdx)** - Learn about field types, relationships, and validation
2. **[Architecture Guide](./architecture.mdx)** - Understand the three-layer architecture
3. **[Security Guide](./security-guide.mdx)** - Implement authentication and permissions
4. **[Writing Hooks](./logic-hooks.mdx)** - Add custom business logic
5. **[SDK Reference](./sdk-reference.mdx)** - Full API documentation

## Common Patterns

Expand Down Expand Up @@ -438,7 +438,7 @@ Check your `permission_set` in the object definition and ensure the user has the

- **[GitHub Repository](https://github.com/objectstack-ai/objectos)** - Source code
- **[ObjectQL Protocol](https://github.com/objectstack-ai/objectql)** - Metadata standard
- **[API Reference](./sdk-reference.md)** - Complete API docs
- **[API Reference](./sdk-reference.mdx)** - Complete API docs

## Community

Expand Down
6 changes: 3 additions & 3 deletions apps/site/content/docs/guide/logic-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,6 @@ EmailActionsPlugin(kernel);

## Related Documentation

- [Logic Hooks](./logic-hooks.md) - Intercept standard operations
- [Security Guide](./security-guide.md) - Configure permissions
- [SDK Reference](./sdk-reference.md) - Complete API reference
- [Logic Hooks](./logic-hooks.mdx) - Intercept standard operations
- [Security Guide](./security-guide.mdx) - Configure permissions
- [SDK Reference](./sdk-reference.mdx) - Complete API reference
6 changes: 3 additions & 3 deletions apps/site/content/docs/guide/logic-hooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,6 @@ AuditPlugin(kernel);

## Related Documentation

- [Custom Actions](./logic-actions.md) - Create custom API endpoints
- [Security Guide](./security-guide.md) - Implement authentication and permissions
- [SDK Reference](./sdk-reference.md) - Complete API reference
- [Custom Actions](./logic-actions.mdx) - Create custom API endpoints
- [Security Guide](./security-guide.mdx) - Implement authentication and permissions
- [SDK Reference](./sdk-reference.mdx) - Complete API reference
8 changes: 4 additions & 4 deletions apps/site/content/docs/guide/sdk-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@ try {

## Related Documentation

- [Data Modeling](./data-modeling.md) - Define objects and fields
- [Logic Hooks](./logic-hooks.md) - Intercept operations
- [Custom Actions](./logic-actions.md) - Create custom endpoints
- [Query Language](../spec/query-language.md) - Filter syntax reference
- [Data Modeling](./data-modeling.mdx) - Define objects and fields
- [Logic Hooks](./logic-hooks.mdx) - Intercept operations
- [Custom Actions](./logic-actions.mdx) - Create custom endpoints
- [Query Language](../spec/query-language.mdx) - Filter syntax reference
6 changes: 3 additions & 3 deletions apps/site/content/docs/guide/security-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,6 @@ describe('Security', () => {

## Related Documentation

- [Logic Hooks](./logic-hooks.md) - Implement custom security logic
- [SDK Reference](./sdk-reference.md) - API reference
- [HTTP Protocol](../spec/http-protocol.md) - Authentication headers
- [Logic Hooks](./logic-hooks.mdx) - Implement custom security logic
- [SDK Reference](./sdk-reference.mdx) - API reference
- [HTTP Protocol](../spec/http-protocol.mdx) - Authentication headers
2 changes: 1 addition & 1 deletion apps/site/content/docs/spec/http-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ GET /api/metadata

### Filtering

See [Query Language Specification](./query-language.md) for complete filter syntax.
See [Query Language Specification](./query-language.mdx) for complete filter syntax.

```bash
curl -X POST http://localhost:3000/api/data/contacts/query \
Expand Down
12 changes: 6 additions & 6 deletions apps/site/content/docs/spec/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ObjectOS implements three core protocols:

## Specifications

### [Metadata Format](./metadata-format.md)
### [Metadata Format](./metadata-format.mdx)

Complete specification of the YAML schema used to define objects, fields, relationships, and permissions. Includes:

Expand All @@ -28,7 +28,7 @@ Complete specification of the YAML schema used to define objects, fields, relati

**Use this when:** Defining new objects or understanding how metadata is structured.

### [Query Language](./query-language.md)
### [Query Language](./query-language.mdx)

Comprehensive guide to the ObjectOS Query Language, including filtering, sorting, and pagination. Includes:

Expand All @@ -40,7 +40,7 @@ Comprehensive guide to the ObjectOS Query Language, including filtering, sorting

**Use this when:** Querying data programmatically or building custom queries.

### [HTTP Protocol](./http-protocol.md)
### [HTTP Protocol](./http-protocol.mdx)

Complete HTTP API reference including all REST endpoints, authentication, and response formats. Includes:

Expand All @@ -55,9 +55,9 @@ Complete HTTP API reference including all REST endpoints, authentication, and re

## Quick Links

- **[Getting Started Guide](../guide/index.md)** - New to ObjectOS? Start here
- **[Architecture Guide](../guide/architecture.md)** - Understand the system design
- **[SDK Reference](../guide/sdk-reference.md)** - Programmatic API reference
- **[Getting Started Guide](../guide/index.mdx)** - New to ObjectOS? Start here
- **[Architecture Guide](../guide/architecture.mdx)** - Understand the system design
- **[SDK Reference](../guide/sdk-reference.mdx)** - Programmatic API reference

## Contributing to Specifications

Expand Down
2 changes: 1 addition & 1 deletion apps/site/content/docs/spec/metadata-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -404,4 +404,4 @@ ObjectOS automatically validates:

### Custom Validation

Define custom validation in hooks (see [Logic Hooks](../guide/logic-hooks.md)).
Define custom validation in hooks (see [Logic Hooks](../guide/logic-hooks.mdx)).
Loading