Repository navigation
docs: Simplify the wording of the product guides, developer guides and API reference - #117
Merged
Merged
Conversation
…d API reference The pages use short sentences, plain words and the labels the product shows. The layout, the navigation, the code samples, the OpenAPI blocks and every URL are the same. Six release notes get a typo fix only.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Approval is blocked by one moderate security-documentation issue that weakens compromised-token guidance, along with three smaller clarity and grammar problems.
4 open issues
What changed in this PR
This PR simplifies wording across product guides, developer documentation, API references, and selected release notes while preserving navigation, URLs, code samples, and OpenAPI blocks.
Changes:
- Rewrites product, help, Genesis, and developer guides with shorter sentences and clearer instructions.
- Adds concise endpoint summaries and usage guidance across the REST API reference.
- Fixes typos in six release notes and clarifies API, authentication, MCP, and app-building guidance.
| File | Description |
|---|---|
| updates-and-timeline/changelog-2026/march-2026/march-5-2026.md | Fixes spacing before a link in the release note. |
| updates-and-timeline/changelog-2026/march-2026/march-31-2026.md | Fixes wording in an improvement note. |
| updates-and-timeline/changelog-2026/march-2026/march-22-2026.md | Fixes a verb tense error in the release note. |
| updates-and-timeline/changelog-2026/march-2026/march-13-2026.md | Removes a duplicated word from the release note. |
| updates-and-timeline/changelog-2026/march-2026/march-10-2026.md | Removes a duplicated article from the release note. |
| updates-and-timeline/changelog-2026/april-2026/april-22-2026.md | Corrects the Claude model name. |
| help-and-support/index/07_api.md | Simplifies API overview and getting-started prose. |
| help-and-support/index/01_workspaces.md | Simplifies workspace concepts and instructions. |
| help-and-support/comprehensive-troubleshooting-guide.md | Clarifies troubleshooting steps and support guidance. |
| genesis-living-system-builder/workspaces/teams.md | Simplifies team and collaboration descriptions. |
| genesis-living-system-builder/workspaces/import.md | Clarifies PDF import options and steps. |
| genesis-living-system-builder/workspaces/embed.md | Simplifies embedding guidance. |
| genesis-living-system-builder/workspaces/collaboration.md | Simplifies collaboration and notification guidance. |
| genesis-living-system-builder/space-apps-guide/app-secrets.md | Clarifies app secret storage, proxying, and publishing safeguards. |
| genesis-living-system-builder/genesis/prompt-guide.md | Simplifies Genesis prompt-writing guidance. |
| genesis-living-system-builder/genesis/mcp-connectors.md | Clarifies inbound and outbound MCP usage. |
| genesis-living-system-builder/genesis/github-import-export.md | Simplifies GitHub import and export instructions. |
| genesis-living-system-builder/genesis/app-analytics.md | Simplifies analytics setup, metrics, and troubleshooting. |
| genesis-living-system-builder/ai-features/tsk-1-model-tiers.md | Simplifies TSK-1 tier and Auto-mode documentation. |
| genesis-living-system-builder/ai-features/media-ai-chat.md | Simplifies media chat methods and supported file guidance. |
| genesis-living-system-builder/ai-features/image-generation.md | Simplifies image-generation instructions and examples. |
| genesis-living-system-builder/ai-features/autopilot.md | Simplifies Autopilot capabilities and workflows. |
| contributing/vision/specs-and-interoperability.md | Simplifies AI Kit and .tsk interoperability guidance. |
| apis-living-system-development/workspace-mcp.md | Clarifies local Workspace MCP setup and behavior. |
| apis-living-system-development/sdk-quickstart.md | Simplifies SDK preview and API quickstart guidance. |
| apis-living-system-development/sdk-cookbook.md | Simplifies SDK integration recipes and error handling. |
| apis-living-system-development/run-your-app-with-ai.md | Simplifies instructions for operating live apps through AI clients. |
| apis-living-system-development/mcp-overview.md | Clarifies how to choose between MCP paths. |
| apis-living-system-development/long-term-memory.md | Simplifies long-term memory concepts and API usage. |
| apis-living-system-development/developers/personal-tokens.md | Clarifies token setup, limits, and replacement guidance. |
| apis-living-system-development/developers/authentication.md | Simplifies personal-token and OAuth documentation. |
| apis-living-system-development/developers/api.md | Simplifies the API overview, surfaces, and error guidance. |
| apis-living-system-development/developer-home.md | Adds direct links to token setup and the first API call. |
| apis-living-system-development/comprehensive-api-guide/workspaces/get-workspaces.md | Adds a concise workspace-listing summary. |
| apis-living-system-development/comprehensive-api-guide/workspaces/get-projects.md | Adds a concise project-creation summary. |
| apis-living-system-development/comprehensive-api-guide/workspaces/get-folders.md | Adds a concise folder-listing summary. |
| apis-living-system-development/comprehensive-api-guide/tasks/update-task.md | Adds task-update usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/update-task-note.md | Adds task-note usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/update-task-field.md | Adds task-field usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/update-task-date.md | Adds task-date usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/update-task-assignees.md | Adds task-assignee usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/uncomplete-task.md | Adds incomplete-task usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/move-task.md | Adds task-movement usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/list-task-fields.md | Adds task-field-listing usage guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/get-task.md | Adds single-task retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/get-task-note.md | Adds task-note retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/get-task-field.md | Adds task-field retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/get-task-date.md | Adds task-date retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/get-task-assignees.md | Adds task-assignee listing guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/delete-task.md | Adds task-deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/delete-task-note.md | Adds task-note deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/delete-task-field.md | Adds task-field deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/delete-task-date.md | Adds task-date deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/delete-task-assignees.md | Adds assignee-removal guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/create-task.md | Adds batched task-creation guidance. |
| apis-living-system-development/comprehensive-api-guide/tasks/complete-task.md | Adds task-completion guidance and restore information. |
| apis-living-system-development/comprehensive-api-guide/projects/update-share-link.md | Adds share-link enablement guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/restore-project.md | Adds archived-project restoration guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-share-link.md | Adds share-link retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-project.md | Adds project retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-project-tasks.md | Adds paginated task-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-project-members.md | Adds paginated member-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-project-fields.md | Adds project-field listing guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/get-project-block.md | Adds paginated block-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/create-project.md | Adds Markdown project-creation guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/create-from-template.md | Adds template-based project-creation guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/copy-project.md | Adds project-copy guidance. |
| apis-living-system-development/comprehensive-api-guide/projects/complete-project.md | Adds project-completion and restoration guidance. |
| apis-living-system-development/comprehensive-api-guide/media/upload-media-to-space.md | Adds media-upload guidance. |
| apis-living-system-development/comprehensive-api-guide/media/get-media.md | Adds media-detail retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/media/download-media.md | Adds media-download guidance. |
| apis-living-system-development/comprehensive-api-guide/media/download-media-from-space.md | Adds ZIP media-download guidance. |
| apis-living-system-development/comprehensive-api-guide/media/delete-media.md | Adds media-deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/me/projects.md | Adds user-project listing guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/get-folder-projects.md | Adds folder project-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/get-folder-project-templates.md | Adds folder template-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/get-folder-medias.md | Adds folder media-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/get-folder-agents.md | Adds folder agent-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/generate-agent-in-folder.md | Adds folder agent-generation guidance. |
| apis-living-system-development/comprehensive-api-guide/folders/create-agent-in-folder.md | Adds folder agent-creation guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/update-public-agent.md | Adds public-agent preference update guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/update-agent.md | Adds agent update guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/update-agent-public-access.md | Adds public-access enablement guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/remove-project-from-agent-knowledge.md | Adds project knowledge-removal guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/remove-media-from-agent-knowledge.md | Adds media knowledge-removal guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/lookup-public-agent.md | Adds public-agent lookup guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/inbound-webhooks.md | Clarifies inbound webhook parameters and setup. |
| apis-living-system-development/comprehensive-api-guide/agents/get-public-agent.md | Adds public-agent retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/get-agent.md | Adds agent retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/get-agent-convos.md | Adds paginated conversation-listing guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/get-agent-convo.md | Adds single-conversation retrieval guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/delete-agent.md | Adds agent-deletion guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/add-project-to-agent-knowledge.md | Adds project knowledge-association guidance. |
| apis-living-system-development/comprehensive-api-guide/agents/add-media-to-agent-knowledge.md | Adds media knowledge-association guidance. |
| apis-living-system-development/api-v2-reference.md | Adds a first-call path and simplifies Action API v2 guidance. |
Review effort: Lite
| ## Replace a compromised token | ||
|
|
||
| If you think that a token is compromised, revoke it and create a new token immediately. | ||
| If you think that another person has a token, revoke it. Then create a new token immediately. |
| <summary>Does MCP work with every AI model?</summary> | ||
|
|
||
| Yes. MCP does not depend on the model. Any AI tool that speaks MCP can connect to Taskade, whatever model it runs. | ||
| Yes. MCP does not depend on the model. Each AI tool that supports MCP can connect to Taskade, with all models. |
| ### Setting Up Project Collaboration | ||
|
|
||
| Before starting conversations, ensure your team is properly invited to collaborate: | ||
| Before you start a conversation, make sure that you invited your team to the project: |
| {% endstepper %} | ||
|
|
||
| On corporate networks, video may require your IT team to allow Taskade through the firewall. See [Collaboration](../genesis-living-system-builder/workspaces/collaboration.md) for video call features. | ||
| On a company network, your IT team can have to allow Taskade through the firewall before video works. See [Collaboration](../genesis-living-system-builder/workspaces/collaboration.md) for video call features. |
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.
What changed
This PR makes 100 pages easier to read. It changes the wording only. The layout, the navigation, the code samples and every URL are the same.
No page in this PR is also in #115 or in the front door PR.
Checks
node .github/scripts/check-facts.mjs: 190 files checked, 0 problems.node .github/scripts/check-twins.mjs --offline: twin footers ok.main: frontmatter keys, GitBook tags, code fences, OpenAPI blocks and footer URLs are the same. No file is renamed, and no relative link is broken.