Skip to content

Commit 0f56bfe

Browse files
committed
feat: Add feature specifications and update documentation structure
1 parent 5a10422 commit 0f56bfe

File tree

4 files changed

+44
-1
lines changed

4 files changed

+44
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,6 +911,18 @@ Development guide: see [Adapter Development Guide](./docs/guides/adapter-develop
911911
| [Registry API](./docs/api/registry-api.md) | Registry API |
912912
| [Executor API](./docs/api/executor-api.md) | Executor API |
913913

914+
### Feature Specifications
915+
916+
| Document | Description |
917+
|------|------|
918+
| [ACL System](./docs/features/acl-system.md) | Pattern-based Access Control List with first-match-wins evaluation |
919+
| [Core Executor](./docs/features/core-executor.md) | Core execution engine with 10-step pipeline |
920+
| [Decorator & YAML Bindings](./docs/features/decorator-bindings.md) | `@module` decorator and YAML-based module creation |
921+
| [Middleware System](./docs/features/middleware-system.md) | Composable middleware pipeline with onion execution model |
922+
| [Observability](./docs/features/observability.md) | Distributed tracing, metrics, and structured logging |
923+
| [Registry System](./docs/features/registry-system.md) | Module discovery, registration, and querying |
924+
| [Schema System](./docs/features/schema-system.md) | Schema loading, validation, `$ref` resolution, and export |
925+
914926
### Usage Guides
915927

916928
| Document | Description |

SCOPE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,7 @@ apcore/
210210
├── concepts.md # Core concepts
211211
├── architecture.md # Internal architecture
212212
├── api/ # API reference
213+
├── features/ # Feature specifications
213214
├── guides/ # Usage guides
214215
└── spec/ # Framework specification
215216
```

docs/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Complete technical documentation for the apcore (AI-Perceivable Core) framework.
44
5-
This directory contains all technical documentation for apcore, covering core concepts, architecture design, API references, usage guides, and framework specifications.
5+
This directory contains all technical documentation for apcore, covering core concepts, architecture design, feature specifications, API references, usage guides, and framework specifications.
66
For a project overview and quick start, see the [main README](../README.md).
77
For language SDK implementations, see [Implementations](../README.md#implementations).
88

@@ -18,6 +18,14 @@ docs/
1818
│ ├── context-object.md ← Context execution context
1919
│ ├── registry-api.md ← Registry center
2020
│ └── executor-api.md ← Executor
21+
├── features/ ← Feature specifications (for SDK implementors)
22+
│ ├── acl-system.md ← Access Control System
23+
│ ├── core-executor.md ← Core Execution Engine
24+
│ ├── decorator-bindings.md ← Decorator and YAML Bindings
25+
│ ├── middleware-system.md ← Middleware System
26+
│ ├── observability.md ← Observability System
27+
│ ├── registry-system.md ← Module Registry and Discovery System
28+
│ └── schema-system.md ← Schema System
2129
├── guides/ ← Usage guides (7 articles)
2230
│ ├── creating-modules.md ← Getting started with module creation
2331
│ ├── schema-definition.md ← Schema definition in detail
@@ -54,6 +62,20 @@ Core interface definitions for the module system, including complete API documen
5462
| [Registry API](./api/registry-api.md) | Module registry center API |
5563
| [Executor API](./api/executor-api.md) | Module executor API |
5664

65+
### [Feature Specifications](./features/)
66+
67+
Implementation-ready feature specifications for SDK developers. Each document defines a specific subsystem's behavior, interfaces, acceptance criteria, and test scenarios.
68+
69+
| Feature Spec | Description |
70+
|--------------|-------------|
71+
| [ACL System](./features/acl-system.md) | Pattern-based Access Control List with first-match-wins evaluation |
72+
| [Core Executor](./features/core-executor.md) | Central orchestration engine with 10-step execution pipeline |
73+
| [Decorator & YAML Bindings](./features/decorator-bindings.md) | `@module` decorator and YAML-based declarative module creation |
74+
| [Middleware System](./features/middleware-system.md) | Composable middleware pipeline with onion execution model |
75+
| [Observability](./features/observability.md) | Distributed tracing, metrics collection, and structured logging |
76+
| [Registry System](./features/registry-system.md) | Module discovery, registration, and querying with 8-step pipeline |
77+
| [Schema System](./features/schema-system.md) | Schema loading, validation, `$ref` resolution, and LLM export |
78+
5779
### [Usage Guides](./guides/)
5880

5981
Practical tutorials covering everything from creating your first module to middleware development, ACL configuration, and cross-language development. 7 guides in total, covering the full path from beginner to advanced.

mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ nav:
6666
- Context Object: api/context-object.md
6767
- Registry API: api/registry-api.md
6868
- Executor API: api/executor-api.md
69+
- Feature Specifications:
70+
- ACL System: features/acl-system.md
71+
- Core Executor: features/core-executor.md
72+
- Decorator & YAML Bindings: features/decorator-bindings.md
73+
- Middleware System: features/middleware-system.md
74+
- Observability: features/observability.md
75+
- Registry System: features/registry-system.md
76+
- Schema System: features/schema-system.md
6977
- User Guides:
7078
- Overview: guides/README.md
7179
- Creating Modules: guides/creating-modules.md

0 commit comments

Comments
 (0)