Skip to content

docs: update project documentation for v0.8.0 - #114

Merged
nutt-adam merged 1 commit into
mainfrom
docs/v0.8.0-release
Mar 22, 2026
Merged

docs: update project documentation for v0.8.0#114
nutt-adam merged 1 commit into
mainfrom
docs/v0.8.0-release

Conversation

@nutt-adam

@nutt-adam nutt-adam commented Mar 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • README: update project status to v0.8.0, add template packs and artifact pipeline to quick start and features, show role mapping in config example
  • CLAUDE.md: add template, automation, and permissions modules to architecture section
  • CHANGELOG: add v0.8.0 entry
  • Cargo.toml: bump version to 0.8.0

Documentation

  • README.md: Updated project status v0.5.0→v0.8.0, added template packs/artifact pipeline/role mapping to features and quick start, added tt init --template examples
  • CLAUDE.md: Added src/template/, src/automation/, src/permissions/ to architecture list
  • CHANGELOG.md: Added v0.8.0 entry with template packs, role mapping, artifact-polling mode, permission fixes
  • Cargo.toml: Version bump 0.7.0→0.8.0

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Template-driven project initialization with built-in templates (gstack-startup, rust-cli, minimal) via tt init --template <name>
    • Role-based runtime assignment for simplified multi-agent configuration
    • Repository auto-detection to suggest appropriate templates
    • Artifact polling mode for workflow artifact completion handling
    • Event metadata now tracks template information
  • Bug Fixes

    • Improved tool support for workflow execution
    • Resolved dashboard sidebar race condition causing stats display issues
  • Version

    • Released v0.8.0

- README: update project status to v0.8.0, add template packs and artifact
  pipeline to quick start and features sections, show role mapping in config
  example, add tt init --template examples
- CLAUDE.md: add template, automation, and permissions modules to architecture
- CHANGELOG: add v0.8.0 entry with template packs, role mapping, artifact
  polling, and permission fixes
- Cargo.toml: bump version to 0.8.0

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 22, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Release v0.8.0 documentation and version bump. Updates reflect new templating system, role-based runtime resolution, template-driven repo detection, artifact polling mode, event metadata fields, and bug fixes for Claude tool support and dashboard race conditions.

Changes

Cohort / File(s) Summary
Version and Release Notes
Cargo.toml, CHANGELOG.md
Version bump to 0.8.0 and comprehensive release notes documenting new template pack system, role-to-runtime indirection, repository auto-detection, artifact polling mode, event metadata extensions, and fixes for Claude tool integration and dashboard sidebar race condition.
Documentation
README.md, CLAUDE.md
Updated project introduction with template selection examples, role-based configuration guidance, feature bullets for templating and artifact pipeline, and version reference; architecture documentation expanded with new src/template/, src/automation/, and src/permissions/ modules and role mapping in config layer.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 With templates sprinkled like carrots in rows,

And roles dancing free where the runtime tree grows,

Version point eight hops into the light,

Artifacts polled and permissions set right,

Our warren of code gets more organized, quite!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is missing critical sections required by the template: no SemVer choice (PATCH/MINOR/MAJOR), no version selected, no validation checks, and no release planning. Add the missing required sections: SemVer choice, version selected field, validation checkboxes, and release/tagging section to match the template structure.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: update project documentation for v0.8.0' directly and clearly summarizes the main change—a documentation update for the v0.8.0 release.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/v0.8.0-release

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can disable sequence diagrams in the walkthrough.

Disable the reviews.sequence_diagrams setting to disable sequence diagrams in the walkthrough.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

99-99: Consider clarifying the role-mapping sentence to include the explicit-runtime override.

Line 99 currently reads as universal; a small tweak to mention “agents without explicit runtime” would match the documented precedence and avoid edge-case confusion.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 99, Update the role-mapping sentence that currently
implies a universal swap (referencing `[roles]` and the example "Swap
`claude-code` for `codex`") to explicitly state that this mapping only applies
to agents that do not have an explicit `runtime` set; mention that agents with
an explicit `runtime` override the `[roles]` mapping. Modify the sentence near
the role-mapping example to read something like "Swap `claude-code` for `codex`
in `[roles]` — this changes the runtime for agents without an explicit `runtime`
setting, so you don't need per-agent edits," and add a short note reminding
readers to version and share or fork as before.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Line 3: Update the release header "## [0.8.0] - 2026-03-23" in CHANGELOG.md so
it doesn't show a future date: either change the date to "Unreleased" or set it
to the actual publish date; locate the header string "## [0.8.0] - 2026-03-23"
and replace the trailing date accordingly before merging.

---

Nitpick comments:
In `@README.md`:
- Line 99: Update the role-mapping sentence that currently implies a universal
swap (referencing `[roles]` and the example "Swap `claude-code` for `codex`") to
explicitly state that this mapping only applies to agents that do not have an
explicit `runtime` set; mention that agents with an explicit `runtime` override
the `[roles]` mapping. Modify the sentence near the role-mapping example to read
something like "Swap `claude-code` for `codex` in `[roles]` — this changes the
runtime for agents without an explicit `runtime` setting, so you don't need
per-agent edits," and add a short note reminding readers to version and share or
fork as before.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 9fd7f185-894f-4fbe-bc5d-ae7195d0ed96

📥 Commits

Reviewing files that changed from the base of the PR and between 11c9743 and a856822.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • CHANGELOG.md
  • CLAUDE.md
  • Cargo.toml
  • README.md

Comment thread CHANGELOG.md
@nutt-adam
nutt-adam merged commit 3dee293 into main Mar 22, 2026
11 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 4, 2026
11 tasks
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