Skip to content

Commit bc8e1ad

Browse files
committed
refactor(docs): remove section headers from multiple protocol documentation files for improved readability
1 parent e23f0eb commit bc8e1ad

10 files changed

Lines changed: 1 addition & 13 deletions

File tree

content/docs/objectql/query-syntax.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Database-agnostic query language with filters, joins, aggregations,
55

66
import { Search, Filter, GitMerge, BarChart } from 'lucide-react';
77

8-
# ObjectQL Query Syntax
98

109
ObjectQL queries are expressed as **Abstract Syntax Trees (AST)** in JSON format. This enables database-agnostic querying—write once, compile to PostgreSQL, MongoDB, Redis, or any supported driver.
1110

content/docs/objectql/schema.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: The complete specification for defining objects, fields, and relati
55

66
import { FileCode, Database, Layers, Package } from 'lucide-react';
77

8-
# Schema Definition
9-
108
In ObjectStack, **data structure is configuration, not code**. The Schema Definition Protocol governs how you declare your data model using declarative `.object.yml` files.
119

1210
> **Single Source of Truth:** This schema drives database DDL, API generation, UI form layouts, permission scopes, and validation rules.

content/docs/objectql/types.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Complete reference for ObjectQL field types - Scalars, relationship
55

66
import { Type, Link, Calculator, Database } from 'lucide-react';
77

8-
# ObjectQL Type System
98

109
ObjectQL provides **20+ specialized field types** that encode business semantics, not just data storage primitives. Each type understands its purpose and automatically configures database schemas, UI renderers, validation rules, and API serialization.
1110

content/docs/objectui/actions.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Buttons, triggers, navigation, and user interaction definitions
55

66
import { MousePointer, Zap, ExternalLink, Workflow, GitBranch, Play, Component, Layout } from 'lucide-react';
77

8-
# Action Protocol: Defining User Interactions
98

109
The **Action Protocol** specifies how user interactions (button clicks, menu selections, gestures) trigger business logic, navigation, or external integrations. Actions are the "verbs" of ObjectUI—they make things happen.
1110

content/docs/objectui/concept.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: The philosophy and architecture of metadata-driven user interfaces
55

66
import { Blocks, Code, Zap, Users, Globe, Shield, Sparkles, Workflow } from 'lucide-react';
77

8-
# UI as Data: The ObjectUI Philosophy
98

109
**Core Thesis:** User interfaces are **configuration, not code**. Forms, dashboards, and reports should be defined in declarative metadata (JSON/YAML), not imperative JavaScript.
1110

content/docs/objectui/layout-dsl.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Declarative layout description language for pages, sections, and re
55

66
import { Layout, Grid, Columns, Box, Monitor, Smartphone, Tablet, MousePointer } from 'lucide-react';
77

8-
# Layout DSL: Composing User Interfaces
98

109
The **Layout DSL** (Domain-Specific Language) is ObjectUI's declarative syntax for defining page structure, sections, and responsive grids. It abstracts away CSS Grid, Flexbox, and platform-specific layout engines.
1110

content/docs/objectui/widget-contract.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Standard props, events, and lifecycle for ObjectUI components
55

66
import { Component, Zap, Code, Check, AlertCircle, Globe } from 'lucide-react';
77

8-
# Widget Contract: Component Specification
98

109
The **Widget Contract** defines the standard interface that all ObjectUI components must implement. This contract ensures consistency across renderers and enables components to be composed, configured, and extended predictably.
1110

content/docs/references/auth/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Auth Protocol Overview
33
description: Complete reference for all auth protocol schemas
44
---
55

6-
# Auth Protocol
76

87
This section contains all protocol schemas for the auth layer of ObjectStack.
98

content/docs/references/data/validation.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
2-
title: Validation
2+
title: Validation Protocol
33
description: Validation protocol schemas
44
---
55

6-
# ObjectStack Validation Protocol
7-
86
This module defines the validation schema protocol for ObjectStack, providing a comprehensive
97

108
type-safe validation system similar to Salesforce's validation rules but with enhanced capabilities.

content/docs/references/protocol-map.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ description: Visual guide to ObjectStack protocol relationships and dependencies
44
---
55

66

7-
# Protocol Architecture Map
87

98
Understand how the 123 ObjectStack protocols fit together to form a complete business platform.
109

0 commit comments

Comments
 (0)