Skip to content

docs: add TakoAPI directory badge#2055

Closed
oratis wants to merge 1 commit into
Zipstack:mainfrom
oratis:add-takoapi-badge
Closed

docs: add TakoAPI directory badge#2055
oratis wants to merge 1 commit into
Zipstack:mainfrom
oratis:add-takoapi-badge

Conversation

@oratis

@oratis oratis commented Jun 14, 2026

Copy link
Copy Markdown

Hi! 👋 unstract 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/zipstack-unstract

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 unstract! 🙏

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a "Listed on TakoAPI" badge link to the local setup section of the README.

Walkthrough

A "Listed on TakoAPI" badge link is inserted into the README.md Run Locally section, placed with surrounding blank lines before the git clone command. No other content is modified.

Changes

TakoAPI Badge in README

Layer / File(s) Summary
TakoAPI badge link in Run Locally section
README.md
Inserts a "Listed on TakoAPI" badge image link with surrounding blank lines before the git clone command in the Run Locally bash block.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description lacks most required template sections (What, Why, How, breaking changes assessment, migrations, env config, etc.) and does not follow the structured format specified in the repository's template. Fill in the required template sections including: What (explain the badge being added), Why (explain the purpose), How (describe the implementation), and crucially the 'breaking changes' section that admins require before merging.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add TakoAPI directory badge' clearly and concisely describes the main change—adding a badge linking to the TakoAPI directory in the README documentation.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

@sonarqubecloud

Copy link
Copy Markdown

@greptile-apps

greptile-apps Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a TakoAPI directory badge to the README, but the badge markdown is accidentally placed inside a fenced bash code block, where it will render as literal text rather than as a clickable image.

  • The badge [![Listed on TakoAPI](...)](...) lands between the # Clone and start comment and the git clone command, meaning GitHub will display the raw markdown syntax inside the shell snippet instead of rendering a visual badge.
  • If the badge is desired, it should be moved outside the code block — most naturally into the existing badge group inside the <div align=\"center\"> section near the top of the README.

Confidence Score: 4/5

The change is documentation-only; merging it as-is adds no functional breakage but the badge will be invisible as a visual element — visitors see raw markdown syntax inside a shell code block instead of a clickable image.

The badge was dropped inside a fenced bash code block rather than the existing badge section, so it will never render as a visual badge on GitHub. The fix is a one-line placement change with no risk to code or other docs content.

README.md — the badge placement inside the fenced code block needs to be corrected before the PR achieves its intended effect.

Important Files Changed

Filename Overview
README.md Adds a TakoAPI badge, but it is placed inside a fenced bash code block, causing it to render as raw markdown text instead of a clickable badge image

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["README.md badge section (lines 9-16)\ndiv align center — existing badges render here"] -->|"should go here"| B["TakoAPI Badge\n[![Listed on TakoAPI](shield URL)](takoapi.com)"]
    C["Run Locally section (line 79)\nbash code block"] -->|"badge placed here (incorrect)"| D["Renders as raw text\n[![Listed on TakoAPI](...)](...)\ngit clone ..."]
Loading

Fix All in Claude Code

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
README.md:79-84
Badge placed inside a fenced bash code block — it will not render as a clickable badge. Inside a fenced code block, GitHub renders content as raw text, so visitors will see the literal markdown syntax `[![Listed on TakoAPI](...)](...)` mixed into the "Run Locally" shell snippet instead of a visual badge. The badge should live outside the code block, ideally in the existing badge section at the top of the README.

```suggestion
```bash
# Clone and start
git clone https://github.com/Zipstack/unstract.git
```

Reviews (1): Last reviewed commit: "docs: add TakoAPI directory badge" | Re-trigger Greptile

Comment thread README.md
Comment on lines 79 to 84
```bash
# Clone and start

[![Listed on TakoAPI](https://img.shields.io/badge/Listed%20on-TakoAPI-7c3aed)](https://takoapi.com/agents/zipstack-unstract)

git clone https://github.com/Zipstack/unstract.git

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.

P1 Badge placed inside a fenced bash code block — it will not render as a clickable badge. Inside a fenced code block, GitHub renders content as raw text, so visitors will see the literal markdown syntax [![Listed on TakoAPI](...)](...) mixed into the "Run Locally" shell snippet instead of a visual badge. The badge should live outside the code block, ideally in the existing badge section at the top of the README.

Suggested change
```bash
# Clone and start
[![Listed on TakoAPI](https://img.shields.io/badge/Listed%20on-TakoAPI-7c3aed)](https://takoapi.com/agents/zipstack-unstract)
git clone https://github.com/Zipstack/unstract.git
```bash
# Clone and start
git clone https://github.com/Zipstack/unstract.git
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 79-84

Comment:
Badge placed inside a fenced bash code block — it will not render as a clickable badge. Inside a fenced code block, GitHub renders content as raw text, so visitors will see the literal markdown syntax `[![Listed on TakoAPI](...)](...)` mixed into the "Run Locally" shell snippet instead of a visual badge. The badge should live outside the code block, ideally in the existing badge section at the top of the README.

```suggestion
```bash
# Clone and start
git clone https://github.com/Zipstack/unstract.git
```

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

79-87: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Badge is placed inside a bash code fence and won't render as a clickable link.

The markdown badge syntax [![...](...)](...) on line 82 is nested within a bash code block (lines 79–87). Inside code fences, markdown syntax is not interpreted—it will display as literal text rather than as a rendered badge with a clickable hyperlink. Additionally, users copying this code block will inadvertently copy the badge markdown as part of their bash commands.

The badge should be placed outside the code fence—either before the opening \``bashor after the closing```` on line 87.

🔧 Proposed fix: Move badge outside the code fence
 ### Run Locally

 ```bash
-# Clone and start
-
-[![Listed on TakoAPI](https://img.shields.io/badge/Listed%20on-TakoAPI-7c3aed)](https://takoapi.com/agents/zipstack-unstract)
-
 git clone https://github.com/Zipstack/unstract.git
 cd unstract
 ./run-platform.sh

+Listed on TakoAPI


Alternatively, place the badge **before** the code block if you prefer it to appear first:

```diff
 ### Run Locally

+[![Listed on TakoAPI](https://img.shields.io/badge/Listed%20on-TakoAPI-7c3aed)](https://takoapi.com/agents/zipstack-unstract)
+
 ```bash
 # Clone and start
 
 git clone https://github.com/Zipstack/unstract.git
 cd unstract
 ./run-platform.sh
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

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 79 - 87, The markdown badge syntax for the TakoAPI
badge is currently nested inside the bash code fence and will not render as a
clickable link—instead it will display as literal text and be copied when users
execute the commands. Move the badge markdown outside the code fence by removing
it from between the opening bash and closing delimiters, and place it
either before the code block (before the opening bash) or after the code block (after the closing ) to ensure it renders properly as a clickable
badge.


</details>

<!-- cr-comment:v1:099dda6bf6c82a35d34db076 -->

</blockquote></details>

</blockquote></details>
🤖 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.

Outside diff comments:
In `@README.md`:
- Around line 79-87: The markdown badge syntax for the TakoAPI badge is
currently nested inside the bash code fence and will not render as a clickable
link—instead it will display as literal text and be copied when users execute
the commands. Move the badge markdown outside the code fence by removing it from
between the opening ```bash and closing ``` delimiters, and place it either
before the code block (before the opening ```bash) or after the code block
(after the closing ```) to ensure it renders properly as a clickable badge.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cdc37137-f3c2-4983-b103-4e3fdba9573f

📥 Commits

Reviewing files that changed from the base of the PR and between 776d0fd and 7f44593.

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

@ritwik-g ritwik-g closed this Jun 15, 2026
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