Skip to content

docs: fix version mismatches, config paths, and broken links - #202

Merged
ajianaz merged 1 commit into
developfrom
fix/docs-version-and-consistency
Jun 7, 2026
Merged

docs: fix version mismatches, config paths, and broken links#202
ajianaz merged 1 commit into
developfrom
fix/docs-version-and-consistency

Conversation

@ajianaz

@ajianaz ajianaz commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes audit findings from website/docs validation after v0.0.10 release.

Changes

Issue Fix Files
#199 Bump version references from v0.0.8 β†’ v0.0.10 README.md, docs/cli-reference.md, docs/roadmap.md
#200 Fix config resolution path to match source code docs/configuration.md
#201 Fix broken pi agent link (was self-referencing) docs/extensions.md

Details

  • Version bump: README badge, CLI Reference header, roadmap current marker
  • Roadmap: Added v0.0.9 (VitePress migration) and v0.0.10 (Codebase quality) sections from CHANGELOG
  • Config paths: Updated configuration.md resolution order to match actual implementation: defaults β†’ ~/.uteke/uteke.toml β†’ .uteke/uteke.toml
  • Extensions: Changed pi agent link from uteke repo to https://pi.dev

Also closed

Closed #178 (Hermes branding removed in v0.0.10), #182 (dual-write fixed), #183 (768d docs corrected) β€” all already in v0.0.10 CHANGELOG.

Closes #199, Closes #200, Closes #201

Summary by CodeRabbit

Documentation

  • Updated version references to v0.0.10 across documentation
  • Clarified configuration discovery order and per-project configuration placement
  • Extended roadmap with completed milestones for versions v0.0.8 through v0.0.10
  • Updated extension reference links

#201)

- Bump version badge from v0.0.8 to v0.0.10 in README
- Update CLI Reference version to 0.0.10
- Add v0.0.9 and v0.0.10 sections to roadmap
- Fix config resolution path in configuration.md to match source code
  (defaults β†’ ~/.uteke/uteke.toml β†’ .uteke/uteke.toml)
- Fix broken pi agent link in extensions.md (was self-referencing)
- Update roadmap to mark v0.0.8 as done, v0.0.10 as current
@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown

Review Change Stack

πŸ“ Walkthrough

Walkthrough

Documentation-only PR synchronizing version numbers from v0.0.8 to v0.0.10 across README and CLI reference, clarifying configuration resolution paths to "last match wins" with .uteke/uteke.toml directory layout, fixing a broken pi agent extension link, and expanding the roadmap with completed v0.0.8 through v0.0.10 entries.

Changes

Documentation Updates

Layer / File(s) Summary
Version Synchronization
README.md, docs/cli-reference.md
Version badge and CLI reference heading bumped from v0.0.8 to v0.0.10; README roadmap/changelog section updated to mark v0.0.10 as current with expanded feature details.
Configuration Path Clarification
docs/configuration.md
Configuration resolution order rewritten to document "last match wins" strategy (built-in defaults β†’ global ~/.uteke/uteke.toml β†’ project-level .uteke/uteke.toml). Per-project config instructions updated from root-level uteke.toml to .uteke/uteke.toml under .uteke/ directory.
Roadmap Expansion and Link Fixes
docs/roadmap.md, docs/extensions.md
Roadmap restructured with v0.0.8 (Stability & Architecture) as done, and new sections for v0.0.9 (Website Migration) and v0.0.10 (Codebase Quality) with detailed completion items. Pi extension documentation link corrected from uteke GitHub repository to pi.dev.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • ajianaz/uteke#174: Prior PR updated README roadmap and version sections to v0.0.8; this PR continues the version updates, bumping those same sections to v0.0.10 alongside additional roadmap/changelog expansion.

Poem

🐰 A rabbit hops through documentation,
Updating versions with dedication!
v0.0.10 shines so bright,
Config paths clarified just right,
Links fixed and roadmap expandedβ€”thump thump! πŸ₯•

πŸš₯ Pre-merge checks | βœ… 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses issues #199, #200, and #201 comprehensively, but does not address issue #178 (removing Hermes branding), which is listed in the linked issues. Issue #178 requires removing Hermes branding from file names (python_hermes.py β†’ python_wrapper.py, test_hermes_integration.py β†’ test_python_wrapper.py), docstrings, and documentation references. These changes are not present in this PR.
βœ… Passed checks (4 passed)
Check name Status Explanation
Description Check βœ… Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check βœ… Passed The title accurately summarizes the PR's main changes: fixing documentation version mismatches, configuration paths, and broken extension links.
Out of Scope Changes check βœ… Passed All changes in the PR are directly scoped to the four linked issues, with no extraneous modifications beyond fixing versions, config paths, and links.
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 fix/docs-version-and-consistency

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.

@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

πŸ” Cora AI Code Review

βœ… No issues found. Code looks good!


Review powered by cora-cli Β· BYOK Β· MIT

@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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

337-339: ⚠️ Potential issue | 🟠 Major | ⚑ Quick win

Configuration precedence order is reversed in README.

Line 337–339 lists project β†’ global β†’ defaults, but the PR objective states resolution should be defaults β†’ ~/.uteke/uteke.toml β†’ .uteke/uteke.toml (last match wins). Please update this list to match implementation and docs/configuration.md to avoid contradictory setup guidance.

πŸ€– Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 337 - 339, The README's configuration precedence list
is reversed; change the three-line ordered list that currently reads
".uteke/uteke.toml (project-level, in cwd)", "~/.uteke/uteke.toml (global
user-level)", "Built-in defaults" so it matches the implemented and documented
resolution order by reordering to "Built-in defaults", "~/.uteke/uteke.toml
(global user-level)", ".uteke/uteke.toml (project-level, in cwd)" and ensure the
wording matches docs/configuration.md so the README and docs are consistent.
πŸ€– Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@README.md`:
- Around line 337-339: The README's configuration precedence list is reversed;
change the three-line ordered list that currently reads ".uteke/uteke.toml
(project-level, in cwd)", "~/.uteke/uteke.toml (global user-level)", "Built-in
defaults" so it matches the implemented and documented resolution order by
reordering to "Built-in defaults", "~/.uteke/uteke.toml (global user-level)",
".uteke/uteke.toml (project-level, in cwd)" and ensure the wording matches
docs/configuration.md so the README and docs are consistent.

ℹ️ Review info
βš™οΈ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 54b1aefc-51da-4172-843d-8efc53cf4641

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between b3eb47a and 9b5a190.

πŸ“’ Files selected for processing (5)
  • README.md
  • docs/cli-reference.md
  • docs/configuration.md
  • docs/extensions.md
  • docs/roadmap.md

@ajianaz
ajianaz merged commit cd4350c into develop Jun 7, 2026
12 of 13 checks passed
@ajianaz
ajianaz deleted the fix/docs-version-and-consistency branch June 7, 2026 04:55
ajianaz added a commit that referenced this pull request Jun 7, 2026
… (#203)

Reorder precedence list to match implementation:
defaults β†’ ~/.uteke/uteke.toml β†’ .uteke/uteke.toml (last match wins)

CodeRabbit catch from PR #202.

Co-authored-by: Zeko (Hermes) <zeko@hermes.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant