Skip to content

Commit 26d3ad1

Browse files
committed
chore: restructured specification into separate files
1 parent 0222c7e commit 26d3ad1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+3119
-1620
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.x"
21+
22+
- name: Install MkDocs and dependencies
23+
run: pip install mkdocs-material
24+
25+
- name: Build and deploy
26+
run: mkdocs gh-deploy --force

β€Ž.gitignoreβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
work/
2+
.vscode
3+
.venv/
4+
__pycache__/
5+
*.pyc
6+
*.pyo
7+
*.pyd
8+
*.db
9+
*.sqlite3
10+
*.log

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.5.0-draft] β€” 2026-02-22
9+
10+
### Added
11+
- Skill testing: `tests/` directory with deterministic assert runner (Β§4 Skills)
12+
- Hook testing: `tests/` directory with fixtures and assert runner (Β§8 Hooks)
13+
- Evals system: top-level `evals/` with agent sandbox execution model (Β§2 Package Format)
14+
- Two-tier testing model: `tests/` (assert, CI-safe, $0) vs `evals/` (LLM-judged, agent sandbox)
15+
- `aam test` and `aam eval` CLI commands
16+
17+
## [0.4.0-draft] β€” 2026-02-19
18+
19+
### Added
20+
- Initial specification covering package format, manifest, skills, commands, prompts, agents, rules, hooks, MCP, compatibility matrix, migration guides, packaging & distribution, dependency resolution, signing & verification, governance, validation rules, security considerations, glossary, and appendix.
21+
- MkDocs-based documentation site with Material theme.
22+
- GitHub Actions workflow for automated GitHub Pages deployment.

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# πŸ“¦ UAAPS β€” Universal Agentic Artifact Package Specification
22

3-
> **Version:** 0.4.0-draft  |  **Status:** 🌐 Open Standard, seeking collaborators
3+
> **Version:** 0.5.0-draft  |  **Status:** 🌐 Open Standard, seeking collaborators
44
55
✍️ **Write once. Deploy to any agent platform.**
66

@@ -19,6 +19,7 @@ Managing AI agent artifacts at scale is a structural mess:
1919
- πŸ’₯ **No composability** β€” loading multiple packages causes silent instruction conflicts with no namespacing.
2020
- βš™οΈ **No lifecycle management** β€” platforms lack hooks for events like `pre-tool-use` or `permission-request` that deterministic agent validation requires.
2121
- πŸ”„ **No update management** β€” there is no standard mechanism to propagate fixes or new versions of skills across projects; every consumer must update manually and in isolation.
22+
- πŸ§ͺ **No testability** β€” there is no standard way to verify that a skill or hook works correctly. Scripts lack test harnesses, and LLM-driven behavior has no eval framework β€” breakage is discovered in production.
2223
- πŸ›‘οΈ **Uncontrolled duplication creates security risk** β€” skills are copy-pasted across repositories with no traceability. Since skills can contain executable scripts, a single compromised or outdated copy can go undetected across dozens of projects, expanding the attack surface with every duplicate.
2324

2425
### πŸ€” Why "Hacking" npm Is Not Enough
@@ -77,6 +78,7 @@ A single `package.agent.json` manifest declares your artifact and makes it consu
7778
| πŸ”’ **Deterministic Resolution** | Lock files guarantee reproducible agent behavior in CI |
7879
| 🧩 **Composability** | Namespaced skills prevent conflicts between packages |
7980
| πŸ“ **Filesystem-First** | No databases, no APIs required β€” just files |
81+
| πŸ§ͺ **Testability** | Two-tier testing: deterministic `tests/` for CI + LLM-judged `evals/` for integration |
8082

8183
---
8284

@@ -95,7 +97,7 @@ To prove the standard works, a reference implementation and management layer are
9597

9698
## πŸ“– Full Specification
9799

98-
The complete specification is in [docs/SPECIFICATION.md](docs/SPECIFICATION.md). It covers:
100+
The specification is published at **[uaaps.github.io/uaaps_docs](https://uaaps.github.io/uaaps_docs/)** and covers:
99101

100102
- πŸ“„ Package manifest schema (`package.agent.json`)
101103
- πŸ—‚οΈ Directory structure conventions
@@ -106,6 +108,13 @@ The complete specification is in [docs/SPECIFICATION.md](docs/SPECIFICATION.md).
106108
- πŸ§ͺ Quality / eval definitions
107109
- πŸ”Œ Vendor extension points (`x-claude`, `x-cursor`, …)
108110

111+
The spec source lives in [`docs/spec/`](docs/spec/) β€” each chapter is a separate Markdown file. To build and preview locally:
112+
113+
```bash
114+
pip install mkdocs-material
115+
mkdocs serve
116+
```
117+
109118
---
110119

111120
## 🀝 Call for Collaboration
@@ -133,7 +142,7 @@ Let's stop building silos and start building a standard. 🌱
133142

134143
## πŸ”¬ Research & Background
135144

136-
Additional context and prior-art analysis is available in [docs/research_list_of_sources.md](docs/research_list_of_sources.md).
145+
Additional context and prior-art analysis is available in [work/research_list_of_sources.md](docs/research_list_of_sources.md).
137146

138147
---
139148

β€ŽVERSIONβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.5.0-draft

0 commit comments

Comments
Β (0)