Skip to content

Commit e86799f

Browse files
committed
feat: Update changelog with 0.2.0 features and fixes, migrate docs changelog to use root file, and bump apcore dependency to 0.13.0+.
1 parent cf04dec commit e86799f

File tree

5 files changed

+24
-39
lines changed

5 files changed

+24
-39
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ jobs:
3030
run: |
3131
# Copy README as index page
3232
cp README.md docs/index.md
33+
cp CHANGELOG.md docs/changelog.md
3334
3435
# Copy logo into docs assets
3536
mkdir -p docs/assets

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.2.0] - 2026-03-12
6+
7+
### Added
8+
9+
- `TypeScriptWriter` to Core Modules tables in README and docs index
10+
- `"typescript"` format to `get_writer()` factory example
11+
- `documentation` and `warnings` fields to `ScannedModule` Fields table
12+
- Serialization Utilities section (`annotationsToDict`, `moduleToDict`)
13+
in Smart Scanning docs
14+
- Changelog page for documentation site
15+
16+
### Fixed
17+
18+
- Updated `WriteResult` table in Output Writers docs with TypeScript naming
19+
and type columns
20+
- Fixed `ai_guidance``metadata.ai_guidance` in AI Enhancement docs
21+
22+
---
23+
524
## [0.1.0] - 2026-03-06
625

726
Initial release. Extracts shared framework-agnostic logic from `django-apcore`

docs/changelog.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ This guide walks you through installing **apcore-toolkit** and using its core mo
77
=== "Python"
88

99
- **Python**: 3.11+
10-
- **apcore**: 0.9.0+
10+
- **apcore**: 0.13.0+
1111

1212
=== "TypeScript"
1313

1414
- **Node.js**: 18+
15-
- **apcore**: 0.9.0+
15+
- **apcore**: 0.13.0+
1616

1717
---
1818

docs/scope.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ A **shared utility library** for framework-specific adapters (e.g., `django-apco
1111
| Responsibility | Description |
1212
|---------------|-------------|
1313
| **Scanning abstractions** | `BaseScanner` ABC, filtering, deduplication, behavioral inference |
14-
| **Schema extraction** | OpenAPI parsing, Pydantic/Zod model flattening, description enrichment |
14+
| **Schema extraction** | OpenAPI parsing, Pydantic/Zod model flattening |
1515
| **Output generation** | Writers for YAML bindings, source code wrappers, and direct Registry registration |
1616
| **Output verification** | Pluggable `Verifier` protocol for validating written artifacts are well-formed |
1717
| **AI metadata enhancement** | SLM-based enrichment for missing descriptions, annotations, and schemas |
18-
| **Formatting** | Data-to-Markdown conversion for AI-perceivable documentation |
18+
| **Formatting** | Data-to-Markdown conversion for AI-perceivable documentation, schema description enrichment |
1919

2020
## What apcore-toolkit Is NOT
2121

0 commit comments

Comments
 (0)