docs: refactor docs and rebrand project to AgentFlow#16
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR renames the project branding to "AgentFlow" across docs and config, removes the Elastic License 2.0 from LICENSE, removes MIT license fields from several package.json files, changes localStorage keys in the workflow editor from Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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)
AGENTS.md (1)
72-75: Consider varying sentence structure for readability.All three bullet points begin with "Subagent", which reads repetitively. A minor rewording could improve flow.
✏️ Optional rewording suggestion
## Subagent Graph Rules -- Subagent links are tool-delegation edges, not execution edges. -- Subagent hierarchies must remain acyclic. -- Subagent targets are tool-only and cannot participate in regular execution edges. +- Links between agents and subagents are tool-delegation edges, not execution edges. +- Hierarchies must remain acyclic (e.g., `A -> B -> A` is invalid). +- Targets of subagent links are tool-only and cannot participate in regular execution edges.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 72 - 75, Reword the three bullets that currently start with "Subagent" to vary sentence structure while preserving meaning: change "Subagent links are tool-delegation edges, not execution edges." to e.g. "Links to subagents represent tool-delegation edges rather than execution edges," change "Subagent hierarchies must remain acyclic." to e.g. "Hierarchies of subagents must remain acyclic," and change "Subagent targets are tool-only and cannot participate in regular execution edges." to e.g. "Targets of subagents are tool-only and cannot participate in regular execution edges." Ensure the revised bullets keep the original semantics and clarity.docs/README.md (1)
1-1: File name is not kebab-case.
docs/README.mddoes not follow the repo naming convention. Consider renaming to a kebab-case name (for example,docs/documentation-map.md) and updating inbound links.As per coding guidelines,
**/*: Use kebab-case for file naming.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/README.md` at line 1, The filename docs/README.md violates the repo's kebab-case rule; rename the file (e.g., to docs/documentation-map.md) and update all inbound links and references (README.md -> documentation-map.md) across the repo, CI docs manifests, and any navigation/index files so paths remain correct; ensure the new kebab-case name is used consistently wherever README.md was referenced.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/web/src/app/workflow-editor.ts`:
- Around line 1601-1602: The storage key rename causes upgrades to lose
persisted data; add migration logic that on first load checks for legacy keys
'agentic-workflow' and 'agentic-run-id', copies their values into the new
STORAGE_KEY and RUN_KEY (the static getters STORAGE_KEY and RUN_KEY in the
workflow-editor module) and then clears or marks the legacy keys migrated;
implement this migration in the editor initialization path (e.g., the
constructor or loadFromStorage / init method) so existing localStorage entries
are preserved for upgrading users.
In `@CLAUDE.md`:
- Line 9: Update the documentation to explicitly state that the UI node labeled
"Condition" maps to the runtime/type field named "if" (i.e., UI "Condition" ==
runtime "if"); mention this mapping next to the list of node types (Start,
Agent, Condition, Approval) and add a short note that workflow definitions and
persisted run records use the "if" field for conditional logic to avoid
confusion during implementation and code reviews.
In `@docs/troubleshooting.md`:
- Around line 39-41: Update the documented endpoint names to match the actual
API routes by replacing the references to `/resume` and `/resume-stream` with
`/api/resume` and `/api/resume-stream` in the conflict explanation; ensure the
sentence “resume from only one client path at a time” also references the `/api`
prefix (e.g., “resume from only one /api client path at a time”) so the examples
and guidance exactly match the implemented routes.
---
Nitpick comments:
In `@AGENTS.md`:
- Around line 72-75: Reword the three bullets that currently start with
"Subagent" to vary sentence structure while preserving meaning: change "Subagent
links are tool-delegation edges, not execution edges." to e.g. "Links to
subagents represent tool-delegation edges rather than execution edges," change
"Subagent hierarchies must remain acyclic." to e.g. "Hierarchies of subagents
must remain acyclic," and change "Subagent targets are tool-only and cannot
participate in regular execution edges." to e.g. "Targets of subagents are
tool-only and cannot participate in regular execution edges." Ensure the revised
bullets keep the original semantics and clarity.
In `@docs/README.md`:
- Line 1: The filename docs/README.md violates the repo's kebab-case rule;
rename the file (e.g., to docs/documentation-map.md) and update all inbound
links and references (README.md -> documentation-map.md) across the repo, CI
docs manifests, and any navigation/index files so paths remain correct; ensure
the new kebab-case name is used consistently wherever README.md was referenced.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (18)
AGENTS.mdCLAUDE.mdLICENSEREADME.mdapps/web/docs/run-readiness.mdapps/web/index.htmlapps/web/src/app/workflow-editor.tsapps/web/src/data/help-content.tsdocs/README.mddocs/api.mddocs/architecture.mddocs/configuration.mddocs/run-persistence.mddocs/troubleshooting.mddocs/workflow-semantics.mdpackage.jsonpackages/types/package.jsonpackages/workflow-engine/package.json
💤 Files with no reviewable changes (2)
- LICENSE
- packages/workflow-engine/package.json
| static get STORAGE_KEY() { return 'agentflow-workflow'; } | ||
| static get RUN_KEY() { return 'agentflow-run-id'; } |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's examine the specific file and lines mentioned
cat -n apps/web/src/app/workflow-editor.ts | sed -n '1595,1610p'Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 675
🏁 Script executed:
# Search for references to the old key names throughout the file
rg -n "agentic-workflow|agentic-run-id" apps/web/src/app/workflow-editor.tsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Search for migration-related logic in the file
rg -n -i "migrate|legacy|old" apps/web/src/app/workflow-editor.tsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 1043
🏁 Script executed:
# Get context around lines 1601-1602 to understand the class structure
sed -n '1590,1650p' apps/web/src/app/workflow-editor.ts | cat -nRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 2540
🏁 Script executed:
# Check git history for the specific lines to see if there was a change
git log -p --follow -S "agentic-workflow" -- apps/web/src/app/workflow-editor.ts | head -100Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Also check if there's any history of "agentflow-workflow" changes
git log --oneline -S "agentflow-workflow" -- apps/web/src/app/workflow-editor.ts | head -20Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 144
🏁 Script executed:
# Check for any reference to old keys anywhere in the entire codebase
rg -r "agentic-workflow|agentic-run-id" --type ts --type tsxRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 489
🏁 Script executed:
# Search for references to old keys properly
rg "agentic-workflow|agentic-run-id"Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Check the git history to see what the keys were originally called
git log --all --oneline -- apps/web/src/app/workflow-editor.ts | head -30Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 2005
🏁 Script executed:
# Check if there's any migration logic that may have been added recently
git log -p -- apps/web/src/app/workflow-editor.ts | grep -A 10 -B 10 "migrate\|legacy" | head -50Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Let's check the initial commit that created these storage keys
git log --all --diff-filter=A -- apps/web/src/app/workflow-editor.tsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 460
🏁 Script executed:
# Let's look at the full git log for workflow-editor.ts with more detail
git log --oneline -20 -- apps/web/src/app/workflow-editor.tsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 144
🏁 Script executed:
# Check the git show for one of the early commits to see what the initial keys were
git show 0f8b5f4:apps/web/src/app/workflow-editor.ts 2>/dev/null | grep -A 5 "STORAGE_KEY\|RUN_KEY" | head -20Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 838
🏁 Script executed:
# Find which commit changed the storage keys from agentic to agentflow
git log -p --all -- apps/web/src/app/workflow-editor.ts | grep -B 20 "agentflow-workflow" | head -50Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Get the commit that introduced agentflow-workflow
git log --all -S "agentflow-workflow" --oneline -- apps/web/src/app/workflow-editor.tsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 144
🏁 Script executed:
# Check if there's any documentation or release notes mentioning this change
find . -type f \( -name "CHANGELOG*" -o -name "RELEASE*" -o -name "NEWS*" \) -exec grep -l "agentflow\|storage\|migration" {} \;Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Let's check the recent commits more carefully to understand the timeline
git log --oneline -50 | head -30Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 144
🏁 Script executed:
# Let's check what the current HEAD is and its commit message
git log -1 --format="%H %s"Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 177
🏁 Script executed:
# Let's check the git diff to see what changed in the current PR/branch
git diff HEAD~1 apps/web/src/app/workflow-editor.ts | grep -A 5 -B 5 "STORAGE_KEY\|RUN_KEY"Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 279
🏁 Script executed:
# Let's see the full commit that changed the keys
git log --all -p -- apps/web/src/app/workflow-editor.ts | grep -B 30 -A 10 "'agentflow-workflow'" | head -100Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 1494
🏁 Script executed:
# Check if this is a rebrand - look for package.json or README mentions
grep -r "agentflow" --include="*.json" --include="*.md" . 2>/dev/null | head -20Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 680
🏁 Script executed:
# Check if there's any code reading from the old storage keys
rg "agentic-workflow|agentic-run-id" --type ts --type tsx --type jsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 120
🏁 Script executed:
# Let's look at the loadInitialWorkflow method more carefully to see the full logic
sed -n '1618,1700p' apps/web/src/app/workflow-editor.ts | cat -nRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 3605
🏁 Script executed:
# Check if loadConfig or constructor has any migration logic
sed -n '1,100p' apps/web/src/app/workflow-editor.ts | cat -nRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 3597
🏁 Script executed:
# Let's check the constructor to see where migration might happen
ast-grep --pattern 'constructor($_) { $$$ }'Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Search for any migration code in the entire codebase
rg -i "migration|migrate" --type ts --type jsRepository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
🏁 Script executed:
# Check the docs for any mention of breaking changes or migration
cat docs/architecture.md | grep -A 5 -B 5 "agentflow\|storage"Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 515
🏁 Script executed:
# Look at package.json to understand the product/version info
cat package.json | head -30Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 1411
🏁 Script executed:
# Check if there's a CHANGELOG or release notes
find . -iname "*change*" -o -iname "*release*" -o -iname "*migration*" | head -10Repository: CodeSignal/learn_bespoke-agentic-workflow-builder
Length of output: 75
Storage key rename breaks localStorage persistence for upgrading users.
Changing from agentic-workflow/agentic-run-id to agentflow-workflow/agentflow-run-id means users upgrading to this version will lose their saved workflows and active run IDs. The old keys will remain orphaned in their localStorage.
Consider adding migration logic to read old keys and copy to new keys on first load, then optionally clear the legacy keys. Alternatively, if this breaking change is intentional as part of the rebrand, document it clearly in release notes so users are aware their local state will not persist.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/web/src/app/workflow-editor.ts` around lines 1601 - 1602, The storage
key rename causes upgrades to lose persisted data; add migration logic that on
first load checks for legacy keys 'agentic-workflow' and 'agentic-run-id',
copies their values into the new STORAGE_KEY and RUN_KEY (the static getters
STORAGE_KEY and RUN_KEY in the workflow-editor module) and then clears or marks
the legacy keys migrated; implement this migration in the editor initialization
path (e.g., the constructor or loadFromStorage / init method) so existing
localStorage entries are preserved for upgrading users.
1 participant
Summary
Validation
Notes