Skip to content

docs: update references from "Supported AI Agents" to "Supported AI T…#1987

Open
MUHAMMEDHAFEEZ wants to merge 10 commits intogithub:mainfrom
MUHAMMEDHAFEEZ:main
Open

docs: update references from "Supported AI Agents" to "Supported AI T…#1987
MUHAMMEDHAFEEZ wants to merge 10 commits intogithub:mainfrom
MUHAMMEDHAFEEZ:main

Conversation

@MUHAMMEDHAFEEZ
Copy link
Copy Markdown

@MUHAMMEDHAFEEZ MUHAMMEDHAFEEZ commented Mar 26, 2026

Claude Code, Cursor, Gemini CLI, and similar entries in the table are AI coding tools/assistants, not autonomous agents. Renaming the section to "Supported AI Tools" is more accurate.

Updated files:

  • README.md: section header, TOC link, and table column header
  • AGENTS.md: reference to the README section
  • docs/upgrade.md: anchor link (#-supported-ai-agents → #-supported-ai-tools)

Description

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

…ools"

Claude Code, Cursor, Gemini CLI, and similar entries in the table are
AI coding tools/assistants, not autonomous agents. Renaming the section
to "Supported AI Tools" is more accurate.

Updated files:
- README.md: section header, TOC link, and table column header
- AGENTS.md: reference to the README section
- docs/upgrade.md: anchor link (#-supported-ai-agents → #-supported-ai-tools)
Copilot AI review requested due to automatic review settings March 26, 2026 21:08
@MUHAMMEDHAFEEZ MUHAMMEDHAFEEZ requested a review from mnriem as a code owner March 26, 2026 21:08
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Renames documentation references from “Supported AI Agents” to “Supported AI Tools” to better reflect that the integrations listed are coding tools/assistants rather than autonomous agents.

Changes:

  • Updated README section title, TOC entry, and table column header to use “Supported AI Tools”.
  • Updated docs/upgrade.md to link to the new README anchor.
  • Updated AGENTS.md instructions to reference the renamed README section.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/upgrade.md Updates the upgrade guide link text/anchor to “Supported AI Tools”.
README.md Renames the “Supported AI Agents” section and table header to “Supported AI Tools”, and updates the TOC entry accordingly.
AGENTS.md Updates contributor instructions to refer to the renamed “Supported AI Tools” section in README.
Comments suppressed due to low confidence (1)

AGENTS.md:112

  • This step now refers to “Supported AI Tools”, but the bullet points below still say “agent” (and the surrounding instructions in this step are about adding a new agent). Please make the terminology consistent (either keep everything as “agent” or update the bullets to “tool” to match the renamed section).
Update the **Supported AI Tools** section in `README.md` to include the new tool:

- Add the new agent to the table with appropriate support level (Full/Partial)
- Include the agent's official website link
- Add any relevant notes about the agent's implementation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Author

@MUHAMMEDHAFEEZ MUHAMMEDHAFEEZ left a comment

Choose a reason for hiding this comment

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

.

@MUHAMMEDHAFEEZ
Copy link
Copy Markdown
Author

@mnriem

Introduce compact page templates (~74% smaller)
Introduce compact command templates (~78% smaller)
Add --format option to specify init (supports compact and markdown)
Implement resolve_template_path() to handle format-based template selection
Add _get_template_format() in agents to auto-load correct command templates
Persist selected format in .specify/init-options.json
Enable automatic usage of compact templates across scaffold and commands

Token usage reduced from 105.9KB → 23.1KB (~78% reduction)

Usage:

specify init <project> --ai claude --format compact
Default remains markdown
  specify init <project> --ai claude --format compact

 Default remains  markdown
Copilot AI review requested due to automatic review settings March 31, 2026 21:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

AGENTS.md:112

  • This section was renamed to “Supported AI Tools”, but the bullets immediately below still refer to “agent” (e.g., “Add the new agent to the table…”). Update the bullets to consistently use “tool” terminology.
Update the **Supported AI Tools** section in `README.md` to include the new tool:

- Add the new agent to the table with appropriate support level (Full/Partial)
- Include the agent's official website link
- Add any relevant notes about the agent's implementation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 31, 2026 21:44
@MUHAMMEDHAFEEZ
Copy link
Copy Markdown
Author

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 6 comments.

Comments suppressed due to low confidence (2)

AGENTS.md:112

  • The section header was renamed to “Supported AI Tools”, but the follow-up bullets still refer to “agent” (e.g., “Add the new agent to the table…”). Update these bullets to consistently use “tool” terminology.
Update the **Supported AI Tools** section in `README.md` to include the new tool:

- Add the new agent to the table with appropriate support level (Full/Partial)
- Include the agent's official website link
- Add any relevant notes about the agent's implementation

README.md:525

  • This bullet list was updated to say “AI coding tool”, but the next sentence still says “If you encounter issues with an agent…”. For consistency with the rename, update that sentence to refer to the AI tool/assistant instead of “agent”.
- **Linux/macOS/Windows**
- [Supported](#-supported-ai-tools) AI coding tool.
- [uv](https://docs.astral.sh/uv/) for package management
- [Python 3.11+](https://www.python.org/downloads/)
- [Git](https://git-scm.com/downloads)

If you encounter issues with an agent, please open an issue so we can refine the integration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 1, 2026 18:44
MUHAMMEDHAFEEZ and others added 3 commits April 1, 2026 20:45
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (3)

src/specify_cli/init.py:1450

  • ensure_constitution_from_template() selects the compact constitution template by reading .specify/init-options.json, but init() calls this function before save_init_options() writes that file (see init() calling ensure_constitution_from_template() before the save_init_options(...) block). On a fresh specify init --format compact, load_init_options() will return {}, so the compact constitution template won’t be used. Consider passing the chosen template_format into this function (or persisting init options earlier) so first-time initialization honors --format.
            if not build_dir.is_dir():
                if tracker:
                    tracker.error("scaffold", "release script produced no output")
                return False

            for item in build_dir.rglob("*"):
                if item.is_file():
                    rel = item.relative_to(build_dir)
                    dest = project_path / rel
                    dest.parent.mkdir(parents=True, exist_ok=True)

src/specify_cli/init.py:1497

  • resolve_template_path() is newly added but doesn’t appear to be used anywhere in the codebase. If it’s intended to be the single place that applies the format fallback logic, consider refactoring callers (e.g., constitution/template selection) to use it; otherwise, removing it would avoid carrying dead code.
            try:
                with script.open("rb") as f:
                    if f.read(2) != b"#!":
                        continue
            except Exception:
                continue
            st = script.stat()
            mode = st.st_mode
            if mode & 0o111:
                continue
            new_mode = mode
            if mode & 0o400:
                new_mode |= 0o100
            if mode & 0o040:
                new_mode |= 0o010

src/specify_cli/init.py:1865

  • The PR title/description describe a docs-only rename (“Supported AI Agents” → “Supported AI Tools”), but this change set also introduces a new --format init option plus compact templates/command variants. Please update the PR title/description to reflect the functional change, or split the format feature into a separate PR to keep review/release notes clear.

        suffix = legacy_dir.name[len("speckit."):]

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 108 to 112
#### 3. Update README Documentation

Update the **Supported AI Agents** section in `README.md` to include the new agent:
Update the **Supported AI Tools** section in `README.md` to include the new tool:

- Add the new agent to the table with appropriate support level (Full/Partial)
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

This section was renamed to “Supported AI Tools”, but the bullets below still refer to “agent” (“Add the new agent…”, “agent's official website link”, etc.). For consistency with the new terminology, update these bullet items to use “tool” as well.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Author

@MUHAMMEDHAFEEZ MUHAMMEDHAFEEZ left a comment

Choose a reason for hiding this comment

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

add compact template format to reduce token usage
Introduce compact page templates (~74% smaller)
Introduce compact command templates (~78% smaller)

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.

3 participants