Skip to content

docs(readme): Lead with a hero GIF, a template notice and the shortest path, and link the main Taskade entry points - #5

Merged
johnxie merged 1 commit into
mainfrom
docs/readme-visual-and-links
Nov 18, 2026
Merged

johnxie merged 1 commit into
mainfrom
docs/readme-visual-and-links

Conversation

@johnxie

@johnxie johnxie commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Before: the README opened with two paragraphs about Taskade, and the Quick Start came after the Workspace DNA table. It had no image, no template notice and no way to report a problem.

After:

  • First screen: one sentence that says what the repo is, a hero GIF, a notice, then the Quick Start.
  • Hero GIF: one Taskade Genesis app with its sign-up page, agent chat, projects, agents and automations. Asset: https://www.taskade.com/static_images/workspace-dna.gif (640x370, 1.9 MB).
  • Notice: this repository is a template for your own App Kit. Report a template problem in the issues of this repo, and a product problem at taskade/taskade.
  • Quick Start: fork or clone, npm install, npm run build (assemble and validate), then import with a token. Steps 1 to 3 need no Taskade account.
  • One supporting GIF in "How It Maps to Taskade": an App Kit page in the Taskade App Factory with its parts and the Clone App Kit button. Asset: https://www.taskade.com/static_images/newsletter-gifs/2026-04-14-app-kits-share-publish.gif (800x450, 0.9 MB), shown at 640 wide.
  • A link row at the end: build an app from a prompt, the Taskade App Factory, the docs, the agent skills and the MCP server.
  • Three moved lines lost their em dashes. No script, kit JSON file or CI file changed.

Checks:

  • npm install, npm run validate, npm run build, and the CI steps npm run assemble and npm run validate pass locally on Node 22 (7 items).
  • Every URL in the file returns 200, and https://www.taskade.com/mcp returns 401 as expected.
  • The GitHub markdown API renders both GIFs, the notice and all tables.

…t path, and link the main Taskade entry points
Copilot AI lite review requested due to automatic review settings November 18, 2026 23:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified in the README updates, which clearly improve onboarding and provide relevant guidance and resource links.

No open issues 🎉

What changed in this PR

Updates the README to make the repository’s purpose and shortest setup path immediately clear, while adding visual guidance, support links, and key Taskade entry points.

Changes:

  • Added a hero GIF, template notice, issue-reporting guidance, and streamlined Quick Start.
  • Added an App Factory GIF and clarified the Workspace DNA documentation.
  • Added links to Taskade’s app builder, App Factory, documentation, agent skills, and MCP server.
File Description
README.md Reorganizes onboarding content and adds visual assets, support guidance, build instructions, and Taskade resource links.

Review effort: Lite

@johnxie
johnxie merged commit b2454a2 into main Nov 18, 2026
5 checks passed
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.

2 participants