Repository navigation
Docs: client setup pages, LinkedIn Ads overview and copy fixes - #43
Merged
Merged
Conversation
Add 6 pages to docs/: setup for Claude Code, Claude Desktop, Codex, Cursor and the CLI, and a LinkedIn Ads overview. They cover the 0.3.0 ad status changes (update_ad, adwarp ad pause|resume|archive). docs/tools.json now says which tools work on the hosted endpoint. HOSTED_LIMITS in packages/mcp/src/tools.ts lists the 6 registered tools that need local resources, and gen-tools writes hosted, hostedSupport (full, limited or none) and hostedNote from it. upload_audience_csv, audience_from_salesforce and the 3 journal tools become hosted: false, inspect_competitor_ads is limited. Copy fixes: a neutral competitor example instead of HubSpot and Ramp, no Meta mention, numerals for counts in the skills, no em dashes in tool descriptions, CLI output, README or examples, the Google env vars listed in google-ads.md, and the endpoint's docs page now says update_campaign and update_ad can set ACTIVE on an explicit ask. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…tions The website's copy check reads a capitalized "Default" as a company name, so reword the 3 skill lines and the update_campaign description that started a sentence with it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merged
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Upstreams the docs pages and text fixes the adwarp.dev docs need, so this repo stays the only source of the docs. The website reads
docs/*.md,docs/tools.jsonandskills/adwarp-*/SKILL.mdfrommain.New pages
docs/clients-claude-code.md,clients-claude-desktop.md,clients-codex.md,clients-cursor.mdandclients-cli.md: setup for each client, a read-only check, and how writes work since 0.3.0 (update_ad,adwarp ad pause|resume|archive).docs/platforms-linkedin-ads.md: what Adwarp does on LinkedIn Ads, area by area, with links to each tool group intools.md.install.mdlinks to the client pages.The pages name no tool counts, so they don't go stale when a release adds a tool.
Hosted support in tools.json
docs/tools.jsonmarked 6 toolshosted: truethathosted.mdsays need local resources. The truth now lives next to the registration code:HOSTED_LIMITSinpackages/mcp/src/tools.tslists the registered tools that can't fully run when hosted, each with a note.gen-tools.mjswriteshosted(works on the hosted endpoint),hostedSupport(full,limitedornone) andhostedNote. It fails ifHOSTED_LIMITSnames a tool the hosted route doesn't register.inspect_competitor_ads), 14 none (upload_audience_csv,audience_from_salesforce, the 3 journal tools and the 9gads_*tools). The hosted endpoint still registers the same 27 tools, so nothing changes at runtime.hosted.md,tools.mdand the README describe the new fields.Copy fixes
index.mdand README: a neutral competitor example in place of HubSpot, and no Meta mention. The endpoint's homepage example follows.adwarp-competitors:<advertiser> --company-id <id>in place of a real company and id.install.md: the Google credentials link points atgoogle-ads.md#setup.config.mdsaid theADWARP_GOOGLE_*variables were listed ingoogle-ads.md, and they weren't.google-ads.mdnow has an Environment variables section, written frompackages/google/src/config.ts: what each variable replaces, that the client id and secret switch the whole config to the environment, that the refresh token works on its own and turns off Google journaling, and thatdefaultConversionActionNameshas no variable.describe()strings (sotools.jsonhas none), from CLI output and help text, from README and ROADMAP, and from the example brief names. Code comments are unchanged.update_campaigndescription are reworded. The website's copy check reads a capitalized "Default" as a company name.apps/webdocs page: it said activation happens only in Campaign Manager. It now saysupdate_campaignandupdate_adset ACTIVE on an explicit ask. It also drops the Meta mention and the old browser scraper claims, since competitor ads have no browser fallback.Checks
pnpm -r build,pnpm -r typecheckandpnpm test(core 19, google 16, creative worker 10) pass.pnpm gen:toolsthengit diff --exit-code -- docs/tools.jsonis clean, so the CI drift check passes.pnpm packplusscripts/smoke.mjspasses: the CLI and both MCP entries list the 36 tools indocs/tools.json.docs/and the skills resolves.The website PR in adwarp-dev/website reads these pages. Merge this one first.
🤖 Generated with Claude Code