Skip to content

docs: ecosystem cross-links, SDK truth fixes, OpenAPI refresh, LICENSE#73

Merged
johnxie merged 2 commits into
mainfrom
docs/ecosystem-truth-and-crosslinks
Jun 10, 2026
Merged

docs: ecosystem cross-links, SDK truth fixes, OpenAPI refresh, LICENSE#73
johnxie merged 2 commits into
mainfrom
docs/ecosystem-truth-and-crosslinks

Conversation

@johnxie

@johnxie johnxie commented Jun 10, 2026

Copy link
Copy Markdown
Member

What

One PR, four themes — all verified against the live API spec, npm registry, and the taskcade codebase:

1. Truth & safety (highest priority)

  • 07_api.md "Official SDKs" advertised three SDKs that don't exist as described: a JS TaskadeAPI class (real preview client exports HttpClient/TaskadePublicApi), a Python example whose pip install taskade resolves to an unrelated third-party package (squatted name — supply-chain hazard), and a Go SDK whose repo 404s. Replaced with working HTTP-first JS/Python examples (verified against the live v1 spec) and an honest preview note pointing at the SDK Quickstart.
  • Same page's quickstart stepper used the wrong host (api.taskade.com) and a fabricated POST /v1/tasks — corrected to www.taskade.com/api/v1 and the real POST /projects/{projectId}/tasks/ with the actual body shape from the spec.
  • April 8 changelog claimed yarn add @taskade/sdk — the package is not yet on public npm (verified 404); hedged to preview status (npm release tracked in growth#431).

2. Ecosystem cross-links — docs.taskade.com previously linked zero Taskade GitHub repos from its developer surfaces. Added: Integration Kit (github.com/taskade/integrations — Zapier & n8n actions/triggers) to the Developer Resources table, SDKs & Tools tab, and the automation integrations contribute-footer; mcp source link on the Workspace MCP row; an Open Source bullet on the home page. Pairs with taskade/taskade#9, taskade/mcp#52, taskade/integrations#18 — together they close the org link graph in all directions.

3. Freshness.gitbook/assets/api-0.1.0.json refreshed from the live v1 spec: 55→64 operations, verified strict superset at (method, path) level, and all 110 {% openapi %} reference blocks re-validated as resolving — zero rendering regressions possible. Deleted 3 orphaned spec duplicates (zero markdown references). Custom-domains FAQ updated to shipped. Speculative "Future Automation Features" replaced with what's live today: EVE (Taskade Autonomous Agent) drafts automations from natural language, and Workflow Automation Mode at taskade.com/create generates workflows from a single prompt — generated flows open in the standard flow editor. Changelog README now points to taskade.com/changelog for the always-current stream.

4. Repo health — LICENSE added (CC BY 4.0, standard for docs content; unblocks aggregators that filter on license). .gitignore excludes internal tracker files.

Genesis context

Taskade Genesis is the AI app builder — one prompt generates a working app backed by your workspace: projects become the database, AI agents the team, automations the execution layer, with 100+ integrations, MCP support, and custom domains now live. These docs surfaces are the front door for developers building on it.

Zero-regression verification (all run pre-push)

  • OpenAPI refresh: old spec ⊆ new spec at (method, path) level (55→64 ops, 0 removed); new JSON valid; 110/110 {% openapi %} blocks resolve against the refreshed asset
  • Orphan spec deletions: re-verified 0 markdown references each
  • All new external URLs return 200 (github.com/taskade{,/integrations,/mcp}, taskade.com/changelog, settings/api)
  • All new relative links resolve to existing files
  • {% hint %}/{% endhint %} balanced in every edited file; {% step %} structure untouched
  • Developer Resources table: consistent 4-pipe rows after edit
  • No SUMMARY.md or .gitbook.yaml changes (zero nav/build risk)
  • grep: no remaining go-sdk, from taskade import, or yarn add @taskade/sdk claims outside archive

Follow-up (filed separately, out of scope here)

knowledge-management.md and ai-forms.md document fabricated API endpoints (/knowledge/bulk-upload, /forms/{id}/submissions — not in the v1 spec) with the same wrong host; needs a content rewrite against the real /agents/{agentId}/knowledge/* endpoints.

cc @deanzaka @lxcid

johnxie added 2 commits June 9, 2026 20:21
Truth & safety:
- 07_api.md: remove fabricated SDK trio (JS class that doesn't exist,
  Python example resolving to an unrelated third-party PyPI package,
  Go SDK whose repo 404s); replace with working HTTP-first examples
  (verified against the live v1 spec) + honest preview note for
  @taskade/sdk; fix wrong api.taskade.com host and fabricated
  POST /v1/tasks in the quickstart stepper
- april-8 changelog: SDK 'yarn add' claim hedged to preview status
- faq.md: custom domains 'Coming soon' -> live (shipped)
- advanced-actions.md: speculative roadmap section replaced with
  present-tense AI automation building (EVE + Workflow Automation Mode)

Cross-links (close the org link graph):
- developer-home: Integration Kit row + mcp source link
- automation/integrations: contribute footer -> taskade/integrations
- developers/README: Integration Kit in SDKs & Tools
- root README: Open Source bullet -> github.com/taskade

Freshness & repo health:
- .gitbook/assets/api-0.1.0.json refreshed from live spec (55->64 ops,
  verified strict superset at method level; all 110 {% openapi %} blocks
  still resolve); 3 orphaned spec duplicates deleted
- changelog-2026 README: pointer to taskade.com/changelog for post-April
- LICENSE: CC BY 4.0; .gitignore: exclude internal tracker files
…rojects

Review caught that GET /projects does not exist in the v1 spec (live: 404);
the real list-your-projects route is /me/projects (live: 401 on fake token,
i.e. real route). POST /projects (create) is unaffected.
@johnxie

johnxie commented Jun 10, 2026

Copy link
Copy Markdown
Member Author

Independent review: APPROVE (after one fix). Review verified: 15-file diff scope, balanced GitBook tags across all 9 edited pages, refreshed spec is a strict superset (0 removed / 9 added ops) with 110/110 {% openapi %} blocks resolving, LICENSE detected, no SUMMARY/.gitbook.yaml changes, all new URLs 200. It also caught one real bug in the new quickstart example — GET /v1/projects doesn't exist (live 404); fixed to the real GET /v1/me/projects (live-verified route). cc @deanzaka @lxcid

@johnxie johnxie merged commit 1dc521d into main Jun 10, 2026
2 checks passed
@johnxie johnxie deleted the docs/ecosystem-truth-and-crosslinks branch June 10, 2026 03:37
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