|
2 | 2 |
|
3 | 3 | > Complete technical documentation for the apcore (AI-Perceivable Core) framework. |
4 | 4 |
|
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. |
6 | 6 | For a project overview and quick start, see the [main README](../README.md). |
7 | 7 | For language SDK implementations, see [Implementations](../README.md#implementations). |
8 | 8 |
|
|
18 | 18 | │ ├── context-object.md ← Context execution context |
19 | 19 | │ ├── registry-api.md ← Registry center |
20 | 20 | │ └── 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 |
21 | 29 | ├── guides/ ← Usage guides (7 articles) |
22 | 30 | │ ├── creating-modules.md ← Getting started with module creation |
23 | 31 | │ ├── schema-definition.md ← Schema definition in detail |
@@ -54,6 +62,20 @@ Core interface definitions for the module system, including complete API documen |
54 | 62 | | [Registry API](./api/registry-api.md) | Module registry center API | |
55 | 63 | | [Executor API](./api/executor-api.md) | Module executor API | |
56 | 64 |
|
| 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 | + |
57 | 79 | ### [Usage Guides](./guides/) |
58 | 80 |
|
59 | 81 | 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. |
|
0 commit comments