Skip to content

docs: Add Airtop browser automation updates (TSP-1225)#617

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1225
Open

docs: Add Airtop browser automation updates (TSP-1225)#617
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1225

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Documentation updates for PR #14292 adding major Airtop browser automation capabilities:

  • New Generic API Call tools (Airtop Generic API Call & Browser API Call)
  • Full-page screenshot capture in page-information
  • Four new browser action steps in page-interaction (Tab key, Clear input, Natural language scrolling, JSON extraction)
  • Updated credit billing model for managed AI Browser

Related: https://github.com/RelevanceAI/relevance-api-node/pull/14292
Linear: TSP-1225

Changes

  • page-information.mdx: Added Full Page and Output Format parameters to Screenshot Page step, plus new FAQs for full-page vs viewport screenshots.
  • page-interaction.mdx: Added four new steps — Airtop - Press Tab, Airtop - Clear Input, Airtop - Natural Language Scroll, Airtop - Extract Structured Data — with corresponding FAQs.
  • api-calls.mdx (new): Documents the Airtop - Generic API Call and Browser - API Call tool steps, including BYOK vs managed AI Browser distinction.
  • docs.json: Added api-calls page to the Airtop Tool Steps navigation group.
  • integrations/popular-integrations/airtop.mdx: Added credit billing model section explaining LLM vs non-LLM operation costs for managed AI Browser users.

https://linear.app/relevance/issue/TSP-1225/

…w browser action steps

- New page: Airtop API Calls — documents 'Airtop - Generic API Call' (BYOK) and 'Browser - API Call' (managed AI Browser) tool steps
- page-information: update Screenshot Page step with full-page capture option and output format selection (dataUrl/base64)
- page-interaction: add four new steps — Press Tab, Clear Input, Natural Language Scroll, Extract Structured Data
- airtop integration: add credit billing section explaining LLM cost passthrough and 5-credit fallback for non-LLM operations

Refs: TSP-1225, RelevanceAI/relevance-api-node#14292

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label May 12, 2026
@linear
Copy link
Copy Markdown

linear Bot commented May 12, 2026

TSP-1225

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 5 files (4 with issues, 1 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Multiple frontmatter title/sidebarTitle violations (title case instead of sentence case across 3 files); one British spelling; copy-pasted wrong integration name in 6 iframe title attributes; "tool" vs "Tool" inconsistency in airtop.mdx.
🟡 Technical clarity 7/10 All 6 demo iframes carry a title attribute reading "Add the Confluence - Create Post Tool step to your Tool" — wrong integration entirely, misleading for screen readers. api-calls.mdx FAQ directs readers to "the Airtop API documentation" with no link.
🟢 Non-technical clarity 8/10 Prerequisites are called out upfront, fields are described with examples, BYOK vs managed-browser distinction is explained clearly. Minor: "Wait Until Timeout Seconds" is labeled (Required) for Type Text but (Optional) for Click Element — worth verifying if this is intentional.
🟢 Structure 9/10 Consistent pattern across all tool-step pages, nav correctly updated in docs.json, reference pages correctly omit CTAs.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The content itself is solid — clear field descriptions, good FAQ coverage, and a well-structured integration page that explains the BYOK vs managed-browser split. The main drag is mechanical: a batch of copy-paste leftovers (Confluence iframe titles in every demo embed, title-case frontmatter across three files) that suggest the pages were scaffolded quickly and not fully swept before submission.

🔧 Issues (10)
  • api-calls.mdx:2 — frontmatter title: "Airtop - API Calls" is title case; sidebarTitle already says "API calls" (correct). Fix title to match: "Airtop - API calls".
  • page-information.mdx:2 — frontmatter title: "Airtop - Page Information & Monitoring""Airtop - Page information & monitoring" (sentence case; "Airtop" is the proper noun, the rest is not).
  • page-information.mdx:4sidebarTitle: "Page Information & Monitoring""Page information & monitoring".
  • page-interaction.mdx:2 — frontmatter title: "Airtop - Page Interaction""Airtop - Page interaction".
  • page-interaction.mdx:4sidebarTitle: "Page Interaction""Page interaction".
  • airtop.mdx:25 — heading ## Connecting the Integration## Connecting the integration ("Integration" is not a proper noun here).
  • airtop.mdx:48 — "Create a new tool in Relevance AI." — "tool" refers to the Relevance AI product feature and should be capitalized: "Create a new Tool in Relevance AI."
  • page-interaction.mdx:164 — "summarisation" is British English → "summarization".
  • page-information.mdx:16,35,54 and page-interaction.mdx:16,36,58 — all six demo <iframe> elements have title="Add the Confluence - Create Post Tool step to your Tool". This is copy-pasted from the Confluence integration docs and is wrong for every embed on these pages. Each title should name the actual step being demonstrated (e.g., "Add the Airtop - Query Page Tool step to your Tool").
  • api-calls.mdx:66 — FAQ answer says "Refer to the Airtop API documentation for a full list of available endpoints" with no link. Add a link to Airtop's API reference so readers don't have to hunt for it.
🧩 Component suggestions (1)
  • page-interaction.mdx:49 — "Wait Until Timeout Seconds" is labeled (Required) for the Type Text step but (Optional) for the Click Element step (line 27). If this difference is intentional and reflects the actual product UI, a short parenthetical note ("required for Type Text because the element must be located before text can be typed") would prevent reader confusion. If it's a copy-paste inconsistency, align the labels.
✅ Clean files (1)

docs.json — the api-calls page is correctly appended to the Airtop nav group; no orphaned entries.

🔋 Credit usage
Item Count
Files reviewed 5
Context pages read 1 (window-management.mdx as sibling)
Total lines processed ~420

Files read: api-calls.mdx (75 lines), page-information.mdx (91 lines), page-interaction.mdx (167 lines), airtop.mdx (85 lines), window-management.mdx (80 lines, context).

- Add full-page screenshot step to page-information
- Add four new page-interaction steps: Tab Key, Clear Input, Scroll Page (Natural Language), Extract JSON
- Add new generic-api-calls page documenting Airtop Generic API Call and Browser API Call tool steps
- Update docs.json navigation to include new generic-api-calls page
- Add credit billing model section to Airtop integration page

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot changed the title docs(TSP-1225): add Airtop Generic API Call, new browser steps, and billing docs docs: Add Airtop browser automation updates (TSP-1225) May 12, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 6 files (6 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 One banned word (leverage), one British spelling (summarisation), title-case in four frontmatter title/sidebarTitle fields and one H2, wrong product-term capitalization for Agents in one accordion.
🟡 Technical clarity 7/10 Contradictory parameter order for the same step between two files; iframe title attributes are copy-pasted from a Confluence page (accessibility metadata is wrong); generic-api-calls.mdx is not reachable from navigation.
🟢 Non-technical clarity 9/10 Prerequisites surfaced up front, FAQ coverage is solid, steps are specific and reference exact UI labels.
🟡 Structure 6/10 generic-api-calls.mdx is an orphaned page (not in docs.json) that partially duplicates content already in api-calls.mdx. The relationship between the two files needs to be resolved before this PR ships.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The step-by-step content is clearly written and follows the repo's established patterns well — prerequisites, field descriptions, and FAQ sections are all done right. The main blocker is the orphaned generic-api-calls.mdx file that overlaps with api-calls.mdx but isn't wired into navigation; that needs a decision (merge, replace, or add to docs.json) before this is shippable. A handful of capitalization and spelling nits are scattered across the other files.

🔧 Issues (8)
  • integrations/popular-integrations/airtop.mdx:83"Agents can leverage these steps..."leverage is a banned word. Rephrase to "Agents can use these steps...".

  • build/tools/tool-steps/airtop-browser-automation/page-interaction.mdx:164"summarisation" is British spelling. Change to "summarization".

  • build/tools/tool-steps/airtop-browser-automation/api-calls.mdx:2 — Frontmatter title: "Airtop - API Calls" — "Calls" is not a proper noun; sentence case: "Airtop - API calls". (The sidebarTitle already has it right: "API calls".)

  • build/tools/tool-steps/airtop-browser-automation/page-information.mdx:2,4 — Both title and sidebarTitle read "Airtop - Page Information & Monitoring" / "Page Information & Monitoring". Sentence case: "Airtop - Page information & monitoring" / "Page information & monitoring".

  • build/tools/tool-steps/airtop-browser-automation/page-interaction.mdx:2,4 — Same pattern: "Airtop - Page Interaction" / "Page Interaction""Airtop - Page interaction" / "Page interaction".

  • integrations/popular-integrations/airtop.mdx:22 — Heading ## Connecting the Integration — "Integration" is not a proper noun. Should be ## Connecting the integration.

  • integrations/popular-integrations/airtop.mdx:82 — Accordion title "Can I use Airtop browser automation in agents?" — here agents refers to Relevance AI Agents (the product feature). Capitalize: "Can I use Airtop browser automation in Agents?".

  • build/tools/tool-steps/airtop-browser-automation/page-information.mdx:16,35,54 and page-interaction.mdx:16,36,57,58 — All embedded <iframe> elements carry title="Add the Confluence - Create Post Tool step to your Tool" — this is a copy-paste from the Confluence integration pages and is incorrect for every Airtop step. The title attribute is read by screen readers; each iframe should reference its actual step, e.g. title="Add the Airtop - Query Page Tool step to your Tool".

🏗️ Page structure (2)
  • build/tools/tool-steps/airtop-browser-automation/generic-api-calls.mdx — This file is not listed in docs.json (the navigation only includes api-calls). The page is unreachable from the sidebar. Decide: if this file represents a distinct set of steps that belong in the nav, add it to docs.json under the "Airtop Tool Steps" group. If api-calls.mdx already covers these steps adequately, delete generic-api-calls.mdx to avoid a duplicate orphan.

  • build/tools/tool-steps/airtop-browser-automation/generic-api-calls.mdx + api-calls.mdx — Both files document the "Airtop - Generic API Call" step. api-calls.mdx is the nav-linked canonical source. Any content unique to generic-api-calls.mdx (notably the "Airtop - Browser API Call" step with Window ID / Session ID params) should either be merged into api-calls.mdx or given its own dedicated page that's properly wired into navigation.

⚠️ Contradictions (1)
  • build/tools/tool-steps/airtop-browser-automation/api-calls.mdx:25 vs build/tools/tool-steps/airtop-browser-automation/generic-api-calls.mdx:20–21 — Both pages document the "Airtop - Generic API Call" step but list the fields in a different order. api-calls.mdx lists Endpoint (step 4) then Method (step 5). generic-api-calls.mdx lists Method (step 4) then Endpoint (step 5). One of these matches the actual UI and one doesn't — verify which is correct and align them.
🔋 Credit usage
Item Count
Files reviewed 6
Context pages read 1 (window-management.mdx)
Total lines processed ~500

Files read: api-calls.mdx (75 lines), generic-api-calls.mdx (65 lines), page-information.mdx (91 lines), page-interaction.mdx (167 lines), integrations/popular-integrations/airtop.mdx (85 lines), build/tools/tool-steps/airtop-browser-automation/window-management.mdx (80 lines, sibling context), docs.json (partial, ~25 lines)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant