Skip to content

Commit e8b0291

Browse files
authored
Merge pull request #319 from objectstack-ai/copilot/fix-action-step-issue-yet-again
2 parents 451cfa1 + cadf79a commit e8b0291

File tree

2 files changed

+18
-24
lines changed

2 files changed

+18
-24
lines changed

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,16 @@ We've completed all advanced query features and AI/ML field types:
3030
* **[Protocol Organization](./PROTOCOL_ORGANIZATION.md):** 🗺️ **Visual diagrams and maps** showing protocol structure, dependencies, and relationships
3131

3232
### Quick Start
33-
* **[Getting Started](./content/docs/guides/getting-started.mdx):** Quick introduction to ObjectStack Protocol
34-
* **[Installation Guide](./content/docs/guides/installation.mdx):** Setup instructions
33+
* **[Protocol Index](./PROTOCOL_INDEX.md):** Quick navigation to all protocol specifications
3534
* **[Contributing Guide](./CONTRIBUTING.md):** How to contribute to the project
3635

3736
### Architecture & Design
38-
* **[Architecture Overview](./content/docs/specifications/architecture/):** Deep dive into the three-layer architecture
39-
* **[Data Layer (ObjectQL)](./content/docs/specifications/architecture/data-layer.mdx):** Query language and data abstraction
40-
* **[UI Layer (ObjectUI)](./content/docs/specifications/architecture/ui-layer.mdx):** Server-driven UI protocol
41-
* **[System Layer (ObjectOS)](./content/docs/specifications/architecture/system-layer.mdx):** Runtime kernel and plugins
37+
* **[Architecture Overview](./ARCHITECTURE.md):** Deep dive into the three-layer architecture
38+
* **[Protocol Organization](./PROTOCOL_ORGANIZATION.md):** Visual diagrams showing protocol structure and dependencies
4239

4340
### Standards & Best Practices
44-
* **[Naming Conventions](./content/docs/standards/naming-conventions.mdx):** Schema naming rules (camelCase vs snake_case)
45-
* **[API Design](./content/docs/standards/api-design.mdx):** API design principles and patterns
46-
* **[Error Handling](./content/docs/standards/error-handling.mdx):** Consistent error handling strategies
47-
* **[Authentication](./content/docs/standards/authentication.mdx):** Authentication standards and implementation
41+
* **[Contributing Guide](./CONTRIBUTING.md):** Includes coding standards and best practices
42+
* **[Protocol Reference](./PROTOCOL_REFERENCE.md):** Detailed documentation with usage examples
4843

4944
### Documentation Site
5045
The official documentation is built with Fumadocs and Next.js.
@@ -54,9 +49,8 @@ The official documentation is built with Fumadocs and Next.js.
5449
* **[Live Site](http://localhost:3000/docs):** Run `pnpm docs:dev` to view locally
5550

5651
### Planning & Internal Docs
57-
* **[Development Roadmap](./internal/planning/DEVELOPMENT_ROADMAP.md):** Complete development plan
58-
* **[Priority Matrix](./internal/planning/PRIORITIES.md):** What to work on next, sprint planning guide
59-
* **[Planning Index](./internal/planning/PLANNING_INDEX.md):** Complete guide to navigating planning documentation
52+
* **[Protocol Extensions Completed](./PROTOCOL_EXTENSIONS_COMPLETED.md):** Recently completed features and updates
53+
* **[Contributing Guide](./CONTRIBUTING.md):** Development workflow and guidelines
6054

6155
## 📦 Monorepo Structure
6256

@@ -168,17 +162,17 @@ We welcome contributions! Please read our **[Contributing Guide](./CONTRIBUTING.
168162
### Quick Start for Contributors
169163

170164
1. **Read the Docs**: Review [CONTRIBUTING.md](./CONTRIBUTING.md) for complete guidelines
171-
2. **Check Priorities**: See [PRIORITIES.md](./internal/planning/PRIORITIES.md) for what to work on next
172-
3. **Understand Architecture**: Read [ARCHITECTURE.md](./ARCHITECTURE.md) for system overview
173-
4. **Follow Standards**: Review [content/docs/standards/](./content/docs/standards/) for coding standards
165+
2. **Understand Architecture**: Read [ARCHITECTURE.md](./ARCHITECTURE.md) for system overview
166+
3. **Explore Protocols**: See [PROTOCOL_REFERENCE.md](./PROTOCOL_REFERENCE.md) for detailed specifications
167+
4. **Check Recent Work**: Review [PROTOCOL_EXTENSIONS_COMPLETED.md](./PROTOCOL_EXTENSIONS_COMPLETED.md) for latest updates
174168

175169
### Key Standards
176170

177-
- **Naming Conventions**: See [content/docs/standards/naming-conventions.mdx](./content/docs/standards/naming-conventions.mdx)
178-
- Configuration keys: `camelCase` (e.g., `maxLength`, `referenceFilters`)
179-
- Machine names: `snake_case` (e.g., `name: 'project_task'`, `object: 'account'`)
180-
- **API Design**: Follow [content/docs/standards/api-design.mdx](./content/docs/standards/api-design.mdx)
181-
- **Error Handling**: Use patterns from [content/docs/standards/error-handling.mdx](./content/docs/standards/error-handling.mdx)
171+
- **Naming Conventions**: Follow consistent naming across the codebase
172+
- Configuration keys (TypeScript properties): `camelCase` (e.g., `maxLength`, `referenceFilters`)
173+
- Machine names (data values): `snake_case` (e.g., `name: 'project_task'`, `object: 'account'`)
174+
- **Zod-First Design**: All schemas must be defined using Zod with runtime validation
175+
- **TypeScript**: Use strict TypeScript with comprehensive JSDoc comments
182176

183177
### PR Checklist
184178

content/docs/developers/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ objectstack publish --registry hub.objectstack.dev
348348
Complete API documentation for all protocols
349349
</Card>
350350

351-
<Card icon="code" title="Examples" href="https://github.com/objectstack/examples">
351+
<Card icon="code" title="Examples" href="https://github.com/objectstack-ai/spec/tree/main/examples">
352352
Production-ready example projects
353353
</Card>
354354

@@ -361,9 +361,9 @@ objectstack publish --registry hub.objectstack.dev
361361

362362
## 🆘 Getting Help
363363

364-
- **Documentation**: [docs.objectstack.dev](https://docs.objectstack.dev)
364+
- **Repository**: [github.com/objectstack-ai/spec](https://github.com/objectstack-ai/spec)
365365
- **Discord**: [discord.gg/objectstack](https://discord.gg/objectstack)
366-
- **GitHub Discussions**: [github.com/objectstack/spec/discussions](https://github.com/objectstack/spec/discussions)
366+
- **GitHub Issues**: [github.com/objectstack-ai/spec/issues](https://github.com/objectstack-ai/spec/issues)
367367
- **Stack Overflow**: Tag your questions with `objectstack`
368368

369369
---

0 commit comments

Comments
 (0)