docs(repo): reorganize documentation structure#131
Merged
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (21)
📝 WalkthroughWalkthroughRepository-wide documentation and config updates to reflect the repository/name change to AgentToolkit/altk-evolve, reorganize the docs site navigation, adjust example paths and links, convert scripts into a Python package (add Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsTimed out fetching pipeline failures after 30000ms 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
mkdocs.yaml (1)
8-9: Consider updatingsite_urlto match the renamed project path.With
repo_name/repo_urlnow onaltk-evolve, leavingsite_urlat/evolvecan cause canonical URL mismatch in generated docs metadata.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@mkdocs.yaml` around lines 8 - 9, The mkdocs config has repo_name/repo_url updated to AgentToolkit/altk-evolve but the site_url remains pointing to /evolve, causing canonical URL mismatch; update the site_url value in mkdocs.yaml to the correct path that matches repo_name/repo_url (e.g., set site_url to the full GitHub Pages URL or to /altk-evolve) so the generated docs metadata uses the same project path as repo_name and repo_url; verify the change by checking the site_url, repo_name, and repo_url entries in mkdocs.yaml.docs/guides/phoenix-sync.md (1)
160-161: Use absolute path touvand consider avoidinguv runin production systemd units.Line 161 uses
/path/to/uvas a placeholder, which is correct, but the systemd best practice for reliability is an absolute path (e.g.,/opt/uv/bin/uvor whereveruvis installed), not/usr/bin/env. However, for production services, avoiduv runentirely: sync the project first withuv sync, then invoke the executable directly from.venv/bin:Recommended approach for production
WorkingDirectory=/path/to/altk-evolve -ExecStart=/path/to/uv run evolve sync phoenix +ExecStart=/path/to/altk-evolve/.venv/bin/evolve sync phoenixIf
uv runis necessary, use the absolute path to theuvbinary rather than relying onenvor PATH resolution.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/phoenix-sync.md` around lines 160 - 161, Update the systemd unit lines referenced by WorkingDirectory and ExecStart so ExecStart uses an absolute path to the uv binary (e.g., /opt/uv/bin/uv) instead of a PATH lookup, and for production avoid using "uv run": run "uv sync" ahead of time and invoke the service executable directly from the virtualenv (e.g., .venv/bin/<executable>) rather than "uv run evolve sync phoenix"; if you must use uv, point ExecStart at the absolute uv binary path (replace "uv run evolve sync phoenix" with "/absolute/path/to/uv run evolve sync phoenix").
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/examples/hello_world/index.md`:
- Line 45: Replace the incorrect reference "uv.lock folder" with "uv.lock file"
in the sentence that instructs deleting .venv and uv.lock; update the wording to
something like "deleting the `.venv` directory and the `uv.lock` file" so the
cleanup step correctly distinguishes the directory `.venv` from the file
`uv.lock` in docs/examples/hello_world/index.md.
In `@docs/installation/index.md`:
- Around line 18-26: The docs removed the "roo" platform but the installer still
supports it; update the installation docs to list "roo" in the CLI usage and
platform table to match the installer. Specifically, restore "roo" as an allowed
value in the usage example and add a table row for `roo` with a brief
description so it aligns with the argument parsing and the install_roo()
implementation in platform-integrations/install.sh.
In `@platform-integrations/claude/plugins/evolve-lite/README.md`:
- Line 48: The README currently references a directory-style storage model
".evolve/entities/" while the linked walkthrough uses a file
".evolve/entities.json"; pick one canonical storage model and make the docs
consistent: either update this README line to point to the walkthrough section
and examples that use ".evolve/entities.json" or update the walkthrough
(../../../../docs/integrations/evolve-lite.md#example-walkthrough) to
demonstrate ".evolve/entities/" markdown files; ensure any example commands,
paths and code snippets in both README and the walkthrough (references to
.evolve/entities/ and .evolve/entities.json) are adjusted to match the chosen
model so users see a single, consistent storage format.
---
Nitpick comments:
In `@docs/guides/phoenix-sync.md`:
- Around line 160-161: Update the systemd unit lines referenced by
WorkingDirectory and ExecStart so ExecStart uses an absolute path to the uv
binary (e.g., /opt/uv/bin/uv) instead of a PATH lookup, and for production avoid
using "uv run": run "uv sync" ahead of time and invoke the service executable
directly from the virtualenv (e.g., .venv/bin/<executable>) rather than "uv run
evolve sync phoenix"; if you must use uv, point ExecStart at the absolute uv
binary path (replace "uv run evolve sync phoenix" with "/absolute/path/to/uv run
evolve sync phoenix").
In `@mkdocs.yaml`:
- Around line 8-9: The mkdocs config has repo_name/repo_url updated to
AgentToolkit/altk-evolve but the site_url remains pointing to /evolve, causing
canonical URL mismatch; update the site_url value in mkdocs.yaml to the correct
path that matches repo_name/repo_url (e.g., set site_url to the full GitHub
Pages URL or to /altk-evolve) so the generated docs metadata uses the same
project path as repo_name and repo_url; verify the change by checking the
site_url, repo_name, and repo_url entries in mkdocs.yaml.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8ce44fb2-7415-4e8f-abf8-fc9746a14de0
📒 Files selected for processing (20)
CONTRIBUTING.mdREADME.mddocs/archive/save-session-as-skill-design.mddocs/examples/hello_world/index.mddocs/guides/configuration.mddocs/guides/extract-trajectories.mddocs/guides/low-code-tracing.mddocs/guides/phoenix-sync.mddocs/index.mddocs/installation/index.mddocs/integrations/evolve-lite.mddocs/operations/docker-testing.mddocs/reference/cli.mddocs/reference/policies.mddocs/tutorials/claude-code-demo.mdmkdocs.yamlplatform-integrations/claude/plugins/evolve-lite/README.mdscripts/__init__.pyscripts/extract_trajectories.pytests/unit/test_extract_trajectories.py
vinodmut
previously approved these changes
Apr 2, 2026
visahak
force-pushed
the
codex/docs-cleanup
branch
from
a127b57 to
1f12655
Compare
illeatmyhat
approved these changes
Apr 2, 2026
Signed-off-by: Vatche Isahagian <vatchei@ibm.com>
Signed-off-by: Vatche Isahagian <vatchei@ibm.com>
illeatmyhat
force-pushed
the
codex/docs-cleanup
branch
from
1f12655 to
490defb
Compare
This was referenced Apr 2, 2026
Merged
Merged
Merged
Merged
Merged
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
Chores