Skip to content

docs: rewrite documentation for density, prep v1.2.0 - #20

Merged
corvid-agent merged 1 commit into
mainfrom
docs/update-for-release
Mar 19, 2026
Merged

docs: rewrite documentation for density, prep v1.2.0#20
corvid-agent merged 1 commit into
mainfrom
docs/update-for-release

Conversation

@corvid-agent

Copy link
Copy Markdown
Collaborator

Summary

  • README rewritten — 780 deletions, 342 insertions. Every line carries new information, no filler or redundancy.
  • Docs site streamlined — pages complement the README instead of duplicating it.
  • CHANGELOG backfilled — added missing v1.1.1 and v1.1.2 entries.
  • Version bumped to 1.2.0 in Cargo.toml, ready for release.

What changed

File Change
README.md Cut filler, merged redundant sections, tightened every table and description
CHANGELOG.md Added 1.1.1 (marketplace fixes), 1.1.2 (merge conflict + CI fixes), 1.2.0 (this PR)
Cargo.toml version = "1.2.0"
docs/index.md Focused landing page, links to detail pages instead of duplicating them
docs/spec-format.md Added "What SpecSync checks" column to required sections table
docs/cli.md Removed duplicate examples, tighter command descriptions
docs/configuration.md Consolidated per-option sections into single table
docs/github-action.md Removed redundant prose around code blocks
docs/ai-agents.md Cut fluff, updated minimal spec example date
docs/architecture.md Compressed design principles into direct statements

Test plan

  • Verify docs site renders correctly at corvidlabs.github.io/spec-sync
  • cargo publish --dry-run succeeds with new version
  • Tag v1.2.0 after merge

🤖 Generated with Claude Code

- Tighten README so every line carries new information
- Streamline docs site pages to complement rather than duplicate README
- Add missing CHANGELOG entries for v1.1.1 and v1.1.2
- Bump Cargo.toml to 1.2.0

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@corvid-agent
corvid-agent merged commit 65c4b74 into main Mar 19, 2026
7 checks passed
@corvid-agent
corvid-agent deleted the docs/update-for-release branch March 19, 2026 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant