Skip to content

Commit ce783f9

Browse files
alanbldclaude
andcommitted
chore: Release v1.0.0
- Bump all crate versions to 1.0.0 - Add CHANGELOG.md with full release notes - Document 20 phases of development 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 48aa373 commit ce783f9

File tree

4 files changed

+110
-3
lines changed

4 files changed

+110
-3
lines changed

CHANGELOG.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Changelog
2+
3+
All notable changes to UTF8DOK are 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+
## [1.0.0] - 2025-12-29
9+
10+
### Initial Release
11+
12+
UTF8DOK is a universal documentation platform with compliance validation, diagram support, and seamless editor integration.
13+
14+
### Added
15+
16+
#### Core Platform
17+
- **AsciiDoc Parser**: High-performance pest-based parser with full block/inline support
18+
- **AST Types**: Rich document model supporting headings, paragraphs, lists, tables, code blocks
19+
- **Diagnostics System**: Structured error reporting with severity levels and code locations
20+
21+
#### Language Server Protocol (LSP)
22+
- Real-time validation as you type
23+
- Go-to-definition for cross-references (`[[id]]` and `<<id>>`)
24+
- Find all references across workspace
25+
- Workspace symbol search
26+
- Document symbols (outline view)
27+
- Semantic token highlighting
28+
29+
#### Compliance Engine
30+
- **Bridge Framework** support for Architecture Decision Records (ADRs)
31+
- Orphan detection (documents must be reachable from entry points)
32+
- Status validation (superseded ADRs require correct status)
33+
- Missing attribute warnings (`:status:`, `:date:`)
34+
- Configurable severity levels (error, warning, info, off)
35+
36+
#### Content Intelligence
37+
- **Diagram Support**: Mermaid, PlantUML, D2 syntax highlighting
38+
- **Writing Quality**: Weasel word detection, passive voice warnings
39+
- Cross-reference validation
40+
41+
#### Command-Line Interface
42+
- `utf8dok init` - Scaffold new documentation workspace
43+
- `utf8dok audit` - CI/CD compliance checking (text, JSON, markdown output)
44+
- `utf8dok dashboard` - Generate HTML compliance reports
45+
- `utf8dok check` - Validate single files
46+
- `utf8dok extract` - Extract AsciiDoc from DOCX
47+
- `utf8dok render` - Render AsciiDoc to DOCX with template
48+
49+
#### VS Code Extension
50+
- LSP client integration
51+
- Status bar with compliance status
52+
- Compliance dashboard webview
53+
- Commands: Show Dashboard, Run Audit, Fix All, Restart Server
54+
55+
#### CI/CD Integration
56+
- GitHub Actions workflow for automated audits
57+
- Markdown output for PR comments
58+
- Strict mode for blocking merges
59+
- Release workflow for multi-platform binaries
60+
61+
#### Documentation
62+
- User Guide (`docs/manual.adoc`)
63+
- Architecture Decision Records
64+
- Dogfooding: UTF8DOK validates its own documentation
65+
66+
### Templates
67+
68+
Two scaffolding templates available via `utf8dok init`:
69+
70+
- **Bridge**: ADR-focused workspace with compliance rules
71+
- **Basic**: Simple AsciiDoc project structure
72+
73+
### Platforms
74+
75+
Pre-built binaries available for:
76+
- Linux (x64)
77+
- macOS (x64, ARM64)
78+
- Windows (x64)
79+
80+
### Minimum Supported Rust Version
81+
82+
Rust 1.70.0
83+
84+
---
85+
86+
## Development Phases
87+
88+
This release represents 20 phases of development:
89+
90+
| Phase | Feature |
91+
|-------|---------|
92+
| 1-5 | Core parser and AST |
93+
| 6 | DOCX round-trip conversion |
94+
| 7-9 | Validation engine and plugins |
95+
| 10 | Universal platform foundation |
96+
| 11 | Workspace intelligence |
97+
| 12 | Compliance engine |
98+
| 13 | Compliance dashboard |
99+
| 14 | Configuration engine |
100+
| 15 | Active assistance |
101+
| 16 | CI/CD auditor |
102+
| 17 | Rich content intelligence |
103+
| 18 | VS Code extension |
104+
| 19 | Production readiness |
105+
| 20 | Day 1 experience |
106+
107+
[1.0.0]: https://github.com/utf8dok/utf8dok/releases/tag/v1.0.0

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ members = [
1010
]
1111

1212
[workspace.package]
13-
version = "0.1.0"
13+
version = "1.0.0"
1414
authors = ["Alan Bld"]
1515
edition = "2021"
1616
license = "MIT OR Apache-2.0"

crates/utf8dok-ast/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ mod tests {
4747

4848
#[test]
4949
fn test_version() {
50-
assert_eq!(VERSION, "0.1.0");
50+
assert_eq!(VERSION, "1.0.0");
5151
}
5252

5353
#[test]

crates/utf8dok-core/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ mod tests {
5353

5454
#[test]
5555
fn test_version() {
56-
assert_eq!(VERSION, "0.1.0");
56+
assert_eq!(VERSION, "1.0.0");
5757
}
5858

5959
/// Test round-trip fidelity: AST -> AsciiDoc -> AST

0 commit comments

Comments
 (0)