Skip to content

docs: add TakoAPI directory badge#1001

Open
oratis wants to merge 1 commit into
potpie-ai:mainfrom
oratis:add-takoapi-badge
Open

docs: add TakoAPI directory badge#1001
oratis wants to merge 1 commit into
potpie-ai:mainfrom
oratis:add-takoapi-badge

Conversation

@oratis

@oratis oratis commented Jul 8, 2026

Copy link
Copy Markdown

Hi! 👋 potpie is listed in the TakoAPI open agent directory — a free, open catalog that helps people discover AI-agent projects ("one API to discover all agents").

Your listing: https://takoapi.com/agents/potpie-ai-potpie

This PR adds a small badge near the top of the README that links back to that listing, so visitors can find the directory entry. It's entirely optional — if you'd prefer not to include it, just close this PR (no hard feelings, and apologies for the noise).

No tracking and no obligations. Thanks for building potpie! 🙏

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • New Features
    • Added a “Listed on TakoAPI” badge to the top of the README, linking to the project’s TakoAPI agent page.

Walkthrough

Added a new "Listed on TakoAPI" badge at the top of README.md, linking to the TakoAPI agent page for potpie-ai-potpie.

Changes

README Badge Update

Layer / File(s) Summary
Add TakoAPI badge
README.md
Inserted a new badge/link at the top of the README pointing to the TakoAPI agent page.

Possibly related PRs

  • potpie-ai/potpie#294: Also modifies README.md to add a new badge/link section in the same location.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the README badge addition for the TakoAPI directory.
Description check ✅ Passed The description matches the README-only badge change and explains its purpose accurately.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Warning

⚠️ This pull request has been flagged as potential spam (promotional) by CodeRabbit slop detection and should be reviewed carefully.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 1-2: The README currently starts with the badge image link instead
of the top-level heading, which will trip markdownlint. Move the badge below the
main H1 so the document begins with the heading and keep the badge placement
under the title in README.md.
🪄 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: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5151231b-fc0a-485b-a9f5-8d46c9b79d4c

📥 Commits

Reviewing files that changed from the base of the PR and between a6ae3da and a73d70f.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +1 to +2
[![Listed on TakoAPI](https://takoapi.com/api/badge/potpie-ai-potpie)](https://takoapi.com/agents/potpie-ai-potpie)

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.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Move the badge below the top-level heading.

markdownlint will flag this because the README now starts with an image link instead of an H1. Keep the badge under the main heading so the doc stays lint-clean.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 1 - 2, The README currently starts with the badge
image link instead of the top-level heading, which will trip markdownlint. Move
the badge below the main H1 so the document begins with the heading and keep the
badge placement under the title in README.md.

Source: Linters/SAST tools

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