Skip to content

Remove prompt orchestrator documentation - #1377

Merged
atxtechbro merged 1 commit into
mainfrom
cleanup/remove-prompt-orchestrator-docs
Oct 10, 2025
Merged

Remove prompt orchestrator documentation#1377
atxtechbro merged 1 commit into
mainfrom
cleanup/remove-prompt-orchestrator-docs

Conversation

@atxtechbro

Copy link
Copy Markdown
Owner

Summary

Remove all orphaned documentation and procedures for the prompt orchestrator system deleted in PR #1355.

Files Removed

Documentation (Obsolete)

  • ✂️ docs/prompt-orchestration.md (42 lines)

    • Described template syntax ({{ INJECT: }}, {{ VARIABLE }})
    • Referenced deleted utils/prompt_orchestrator.py
    • Referenced non-existent .claude/command-templates/
  • ✂️ docs/prompt-orchestrator-security.md (65 lines)

    • Security documentation for deleted orchestrator
    • Referenced non-existent test_prompt_security.py
    • Described protections for code that no longer exists

Procedure (Obsolete)

Artifacts (Untracked)

  • ✂️ utils/pycache/prompt_orchestrator.cpython-312.pyc
    • Compiled bytecode from deleted orchestrator
    • Not tracked by git, removed manually

Total: ~150 lines of dead documentation removed

Updated

systems-stewardship.md:26

Updated gitignore documentation example:

  • ❌ Old: Referenced deleted .claude/command-templates
  • ✅ New: References current mlruns/ (MLflow tracking data)

Context

Original Removal (Oct 9, 2025)

PR #1355 (commit 688fe9d) removed the entire template generation system:

  • Deleted utils/prompt_orchestrator.py (393 lines)
  • Deleted command generation scripts (877 lines)
  • Total: 1,131 lines removed

Why Documentation Remained

The orchestrator docs and dependent procedure were missed during the initial cleanup, creating orphaned references to deleted tooling.

Replacement System

Impact

  • ✅ Zero functional loss - all referenced deleted systems
  • ✅ Removed stale documentation preventing confusion
  • ✅ Updated principle example to reference current architecture
  • ✅ Cleaner docs/ and procedures/ structure

Related


Principle: subtraction-creates-value

@amazon-q-developer

Copy link
Copy Markdown
Contributor

Code review in progress. Analyzing for code quality issues and best practices. Detailed findings will be posted upon completion.

Using Amazon Q Developer for GitHub

Amazon Q Developer1 is an AI-powered assistant that integrates directly into your GitHub workflow, enhancing your development process with intelligent features for code development, review, and transformation.

Slash Commands

Command Description
/q <message> Chat with the agent to ask questions or request revisions
/q review Requests an Amazon Q powered code review
/q help Displays usage information

Features

Agentic Chat
Enables interactive conversation with Amazon Q to ask questions about the pull request or request specific revisions. Use /q <message> in comment threads or the review body to engage with the agent directly.

Code Review
Analyzes pull requests for code quality, potential issues, and security concerns. Provides feedback and suggested fixes. Automatically triggered on new or reopened PRs (can be disabled for AWS registered installations), or manually with /q review slash command in a comment.

Customization

You can create project-specific rules for Amazon Q Developer to follow:

  1. Create a .amazonq/rules folder in your project root.
  2. Add Markdown files in this folder to define rules (e.g., cdk-rules.md).
  3. Write detailed prompts in these files, such as coding standards or best practices.
  4. Amazon Q Developer will automatically use these rules when generating code or providing assistance.

Example rule:

All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled.
All Amazon SNS topics must have encryption enabled and enforce SSL.
All Amazon SNS queues must enforce SSL.

Feedback

To provide feedback on Amazon Q Developer, create an issue in the Amazon Q Developer public repository.

For more detailed information, visit the Amazon Q for GitHub documentation.

Footnotes

  1. Amazon Q Developer uses generative AI. You may need to verify generated code before using it in your environment. See the AWS Responsible AI Policy.

@amazon-q-developer amazon-q-developer 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.

✅ Excellent Cleanup Work

This PR effectively completes the cleanup started in PR #1355 by removing all orphaned documentation and procedures for the deleted prompt orchestrator system. The changes demonstrate good systems stewardship principles.

Key Strengths

Thorough Documentation Cleanup: Removes 149 lines of obsolete documentation that referenced deleted systems, preventing future confusion and maintenance overhead.

Consistent Architecture Alignment: Updates the gitignore documentation example to reference current systems (mlruns/) instead of deleted ones (.claude/command-templates), maintaining educational value while reflecting reality.

Clear Intent and Context: The PR description provides excellent context about what was removed, why it was orphaned, and how the current system works differently.

Impact Assessment

  • Zero functional impact - all removed content referenced deleted systems
  • Improved maintainability - eliminates stale documentation that could mislead developers
  • Better developer experience - cleaner docs structure without dead references

This cleanup exemplifies the "subtraction-creates-value" principle mentioned in the PR. The removal of obsolete documentation makes the remaining documentation more valuable and trustworthy.

Recommendation: Approve and merge. This is exactly the kind of proactive maintenance that prevents technical debt accumulation.

- **Never let a crisis go to waste**: Each failure becomes input for stronger procedures and prevention systems
- **Leave cookie crumbs**: Document architectural decisions inline where future engineers encounter them. Git commit messages fade into history; inline comments create discoverable breadcrumbs for faster resolution.
- **Gitignore as architectural documentation**: Every gitignore entry embeds meaning about system structure. `# Setup-generated symlinks (avoid duplicating tracked content)` tells the story of why `.claude/command-templates` exists. Each line is a clue to underlying architecture, not just file exclusion.
- **Gitignore as architectural documentation**: Every gitignore entry embeds meaning about system structure. `# MLflow experiment tracking data (regenerated on each run)` tells the story of why `mlruns/` is excluded. Each line is a clue to underlying architecture, not just file exclusion.

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.

Good update to keep the documentation example current and relevant. The change from .claude/command-templates (deleted system) to mlruns/ (current MLflow tracking) maintains the educational value of the example while reflecting the actual architecture.

Remove all documentation, procedures, and vestigial syntax for the prompt
orchestrator system deleted in PR #1355 (Oct 9, 2025). The entire template
generation architecture was replaced by Claude Code's native plugin system.

## Files Removed

**Documentation (obsolete):**
- `docs/prompt-orchestration.md` - Described template syntax for deleted orchestrator
- `docs/prompt-orchestrator-security.md` - Security docs for deleted code

**Procedure (obsolete):**
- `knowledge/procedures/command-lifecycle-management.md` - Referenced deleted tools:
  - utils/sync-claude-commands.sh (removed PR #1355)
  - utils/generate-commands.sh (removed PR #1355)
  - .claude/command-templates/ (never existed)

**Artifacts (untracked):**
- `utils/__pycache__/prompt_orchestrator.cpython-312.pyc` - Not in git, removed manually

## Vestigial Syntax Removed

**commands/close-issue.md** - Removed 2 non-functional markers:
- Line 52: `{{ INJECT:principles/tracer-bullets.md }}`
- Line 69: `{{ INJECT:principles/eager-evolution.md }}`

**commands/extract-best-frame.md** - Removed 1 non-functional marker:
- Line 211: `{{ INJECT:principles/tracer-bullets.md }}`

These `{{ INJECT: }}` markers were remnants of the deleted orchestrator's
template processing. They're not processed by any current system - GitHub
Actions only processes `{{ KNOWLEDGE_BASE }}` and local commands don't
process them at all. The principles are already available in context,
making these markers vestigial documentation cruft.

## Updated

**knowledge/principles/systems-stewardship.md:26** - Updated gitignore example:
- Old: Referenced deleted `.claude/command-templates`
- New: References current `mlruns/` (MLflow tracking data)

## Context

The prompt orchestrator (utils/prompt_orchestrator.py) was removed in
commit 688fe9d along with 1,131 lines of template generation tooling.
These docs and syntax markers were orphaned but not removed at the time.

## Impact

- 3 docs files removed (~150 lines)
- 1 procedure removed (42 lines)
- 3 vestigial syntax markers removed
- 1 principle example updated
- Zero functional loss - all referenced deleted systems or non-functional syntax

Related to #1355 (orchestrator removal)
Related to #1352 (plugin system replacement)

Principle: subtraction-creates-value
@atxtechbro
atxtechbro force-pushed the cleanup/remove-prompt-orchestrator-docs branch from 9c4c56a to 1651046 Compare October 10, 2025 08:17
@atxtechbro
atxtechbro merged commit 3b1c4b6 into main Oct 10, 2025
@atxtechbro
atxtechbro deleted the cleanup/remove-prompt-orchestrator-docs branch October 10, 2025 08:30
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