Skip to content

docs: Update README for egg-sdlc CLI [doc-updater] - #666

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-sdlc-cli
Feb 14, 2026
Merged

docs: Update README for egg-sdlc CLI [doc-updater]#666
jwbron merged 1 commit into
mainfrom
egg/doc-update-sdlc-cli

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update documentation to reflect that egg-sdlc is the primary interface for launching SDLC pipelines, replacing the previous Claude-as-collaborator workflow.

Update documentation to reflect changes from PR #656 (Replace Claude SDLC collaborator with egg-sdlc rich CLI):

  • README.md: Update "How It Works" section to reference egg-sdlc CLI as the primary interface
  • README.md: Update "Starting a Pipeline" examples to show egg-sdlc first, with /sdlc as an alternative
  • README.md: Update Quick Start to recommend egg-sdlc for launching pipelines
  • sandbox/.claude/commands/README.md: Clarify that /sdlc now redirects to the egg-sdlc CLI

The /sdlc skill still exists for backward compatibility but now redirects users to use egg-sdlc directly for better TTY support and interactive features.

Triggered by: PR #656

Authored-by: egg

Update documentation to clarify that egg-sdlc is the primary interface for
launching SDLC pipelines, replacing the previous Claude-as-collaborator
workflow. The /sdlc skill still exists but now redirects to egg-sdlc.

Changes:
- README.md: Update "How It Works" section to reference egg-sdlc CLI
- README.md: Update "Starting a Pipeline" examples to show egg-sdlc first
- README.md: Update Quick Start to recommend egg-sdlc
- sandbox/.claude/commands/README.md: Clarify /sdlc redirects to egg-sdlc

Triggered by: PR #656 (Replace Claude SDLC collaborator with egg-sdlc rich CLI)

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Documentation-only change, two files, limited scope. Reviewed both files and surrounding context.

Changes are correct and consistent. The README and commands README accurately reflect the transition from /sdlc skill to egg-sdlc CLI introduced in PR #656. The /sdlc backward-compatibility note is appropriate. The docs/guides/sdlc-pipeline.md and sandbox/.claude/commands/sdlc.md were already updated (presumably in #656 itself), so no stale references remain.

No issues found.

One minor observation (non-blocking):

sandbox/.claude/commands/README.md — The /sdlc section removed the bullet "Shows how to monitor progress" without replacing it. The new bullets describe egg-sdlc capabilities but don't mention monitoring. This is fine since monitoring is covered in the sdlc.md command file itself, but worth noting for completeness.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No agent-mode design concerns. This is a documentation-only change updating references from the /sdlc skill to the egg-sdlc CLI as the primary interface. No anti-patterns introduced.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@jwbron
jwbron merged commit 5c4afb1 into main Feb 14, 2026
31 checks passed
james-in-a-box Bot pushed a commit that referenced this pull request Feb 14, 2026
Address review feedback from PR #666 noting that the 'Shows how to
monitor progress' bullet was removed without replacement. Add reference
to egg-pipeline-watch for monitoring pipeline progress.
@james-in-a-box

Copy link
Copy Markdown
Contributor Author

Thanks for catching the missing monitoring mention. PR #666 is already merged, so I've addressed this in a follow-up: #667 adds a bullet referencing egg-pipeline-watch for monitoring pipeline progress.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

2 previous review(s) hidden.

jwbron pushed a commit that referenced this pull request Feb 14, 2026
* docs: Add monitoring mention to /sdlc command description

Address review feedback from PR #666 noting that the 'Shows how to
monitor progress' bullet was removed without replacement. Add reference
to egg-pipeline-watch for monitoring pipeline progress.

* docs: Rephrase monitoring bullet for style consistency

---------

Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com>
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