Repository navigation
docs(readme): Lead with a hero GIF, a template notice and the shortest path, and link the main Taskade entry points - #5
Merged
Conversation
…t path, and link the main Taskade entry points
There was a problem hiding this comment.
🟢 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
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.
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:
https://www.taskade.com/static_images/workspace-dna.gif(640x370, 1.9 MB).npm install,npm run build(assemble and validate), then import with a token. Steps 1 to 3 need no Taskade account.https://www.taskade.com/static_images/newsletter-gifs/2026-04-14-app-kits-share-publish.gif(800x450, 0.9 MB), shown at 640 wide.Checks:
npm install,npm run validate,npm run build, and the CI stepsnpm run assembleandnpm run validatepass locally on Node 22 (7 items).https://www.taskade.com/mcpreturns 401 as expected.