Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ export default withMermaid(defineConfig({

transformPageData(pageData) {
const head = pageData.frontmatter.head ??= []

// Inject canonical URL if not already defined in frontmatter
const hasCanonical = head.some(
([tag, attrs]) => tag === 'link' && attrs?.rel === 'canonical'
)
Expand All @@ -134,6 +136,12 @@ export default withMermaid(defineConfig({
.replace(/\.md$/, '')
head.push(['link', { rel: 'canonical', href: canonicalUrl }])
}

// Inject frontmatter keywords as a meta tag (VitePress doesn't do this natively)
const keywords = pageData.frontmatter.keywords
if (keywords) {
head.push(['meta', { name: 'keywords', content: keywords }])
}
},

themeConfig: {
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/customer/delete-customer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a customer
description: Delete a customer via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete a customer record via Plane API. Removes the customer and unlinks associated work items. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/cycle/delete-cycle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a cycle
description: Delete a cycle via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete a cycle via Plane API. Removes the cycle and disassociates its work items. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, cycles, sprints, iterations
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/inbox-issue/delete-inbox-issue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete intake issue
description: Delete intake issue via Plane API. HTTP DELETE request for removing resources.
description: Delete an intake issue from the inbox via Plane API. Permanently removes the triaged submission. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/initiative/delete-initiative.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete an initiative
description: Delete an initiative via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete an initiative via Plane API. Removes the initiative and disassociates linked epics, projects, and labels. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, initiatives, roadmap, planning
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/intake-issue/delete-intake-issue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete an intake work item
description: Delete an intake work item via Plane API. HTTP DELETE request for removing resources.
description: Delete an intake work item via Plane API. Permanently removes the submission from the intake queue. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, work items, issues, tasks, intake, triage, submissions
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/issue-attachments/delete-attachment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete an attachment
description: Delete an attachment via Plane API. HTTP DELETE request for removing resources.
description: Delete a file attachment from a work item via Plane API. Permanently removes the uploaded file. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, work items, issues, tasks, attachments, files, uploads
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/issue-comment/delete-issue-comment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a work item comment
description: Delete a work item comment via Plane API. HTTP DELETE request for removing resources.
description: Delete a comment from a work item via Plane API. Permanently removes the comment and its content. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, work items, issues, tasks, comments, discussion, collaboration
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/issue/delete-issue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a work item
description: Delete a work item via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete a work item via Plane API. Removes the issue and its associated comments, links, and attachments. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/label/delete-label.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a label
description: Delete a label via Plane API. HTTP DELETE request for removing resources.
description: Delete a label from a project via Plane API. Removes the label and disassociates it from all work items. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, labels, tags, categorization
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/link/add-link.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create a link
description: Create a link via Plane API. HTTP POST request format, required fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, create link, add url reference, work item link, issue link, rest api, api integration
---


Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/link/delete-link.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Delete a link
description: Delete a link via Plane API. HTTP DELETE request for removing resources.
keywords: plane, plane api, rest api, api integration
description: Remove a URL link from a work item via Plane API. Deletes the link reference without affecting the target URL. Returns 204 on success.
keywords: plane api, delete link, remove link, work item link, issue link, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/link/get-link-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Retrieve a link
description: Get retrieve a link details via Plane API. Retrieve complete information for a specific resource.
keywords: plane, plane api, rest api, api integration
keywords: plane api, get link detail, retrieve link, work item link, issue link, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/link/list-links.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List all links
description: List all links via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, list links, get all links, work item links, issue links, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/link/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: Plane Link API overview. Learn about endpoints, request/response format, and how to work with link via REST API.
keywords: plane, plane api, rest api, api integration
keywords: plane api, rest api, work item links, issue links, url references, link management, plane integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/link/update-link-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Update a link
description: Update a link via Plane API. HTTP PATCH request format, editable fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, update link, modify link, work item link, issue link, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/members/get-project-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List all project members
description: List all project members via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration, projects, project management
keywords: plane api, project members, list project members, member roles, project management, user management, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/members/get-workspace-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Get all workspace members
description: List all workspace members via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, workspace members, list members, member roles, user management, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/members/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: Plane Members API overview. Learn about endpoints, request/response format, and how to work with members via REST API.
keywords: plane, plane api, rest api, api integration
keywords: plane api, members, workspace members, team members, member roles, user management, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/module/delete-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a module
description: Delete a module via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete a module via Plane API. Removes the module and disassociates its work items. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, modules, features
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/project/delete-project.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a project
description: Delete a project via Plane API. HTTP DELETE request for removing resources.
description: Permanently delete a project and all its data via Plane API. This action is irreversible and removes all work items, cycles, and modules within the project.
keywords: plane, plane api, rest api, api integration, projects, project management
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/state/delete-state.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a state
description: Delete a state via Plane API. HTTP DELETE request for removing resources.
description: Delete a workflow state from a project via Plane API. The state must not be in use by any work items. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, states, workflow, status
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sticky/add-sticky.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create a sticky
description: Create a sticky via Plane API. HTTP POST request format, required fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, create sticky, add note, sticky note, quick capture, rest api, api integration
---


Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/sticky/delete-sticky.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Delete a sticky
description: Delete a sticky via Plane API. HTTP DELETE request for removing resources.
keywords: plane, plane api, rest api, api integration
description: Delete a sticky note via Plane API. Permanently removes the note from your workspace. Returns 204 on success.
keywords: plane api, delete sticky, remove note, sticky note, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sticky/get-sticky-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Retrieve a sticky
description: Get retrieve a sticky details via Plane API. Retrieve complete information for a specific resource.
keywords: plane, plane api, rest api, api integration
keywords: plane api, get sticky detail, retrieve note, sticky note, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sticky/list-stickies.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List all stickies
description: List all stickies via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, list stickies, get all notes, sticky notes, quick notes, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sticky/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: Plane Sticky API overview. Learn about endpoints, request/response format, and how to work with sticky via REST API.
keywords: plane, plane api, rest api, api integration
keywords: plane api, sticky notes, quick notes, personal notes, workspace stickies, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sticky/update-sticky-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Update a sticky
description: Update a sticky via Plane API. HTTP PATCH request format, editable fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, update sticky, modify note, sticky note, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/add-projects-to-teamspace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Add projects to teamspace
description: Create projects to teamspace via Plane API. HTTP POST request format, required fields, and example responses.
keywords: plane, plane api, rest api, api integration, projects, project management
keywords: plane api, add projects to teamspace, team project management, team collaboration, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/add-teamspace-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Add members to teamspace
description: Create members to teamspace via Plane API. HTTP POST request format, required fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, add teamspace members, invite team members, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/add-teamspace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create a teamspace
description: Create a teamspace via Plane API. HTTP POST request format, required fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, create teamspace, add team, team management, workspace teams, rest api, api integration
---


Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/teamspace/delete-teamspace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Delete a teamspace
description: Delete a teamspace via Plane API. HTTP DELETE request for removing resources.
keywords: plane, plane api, rest api, api integration
description: Delete a teamspace via Plane API. Removes the team grouping and disassociates its members and projects. Returns 204 on success.
keywords: plane api, delete teamspace, remove team, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/get-teamspace-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Retrieve a teamspace
description: Get retrieve a teamspace details via Plane API. Retrieve complete information for a specific resource.
keywords: plane, plane api, rest api, api integration
keywords: plane api, get teamspace detail, retrieve team, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/list-teamspace-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List all teamspace members
description: List all teamspace members via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, list teamspace members, team members, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/list-teamspace-projects.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List teamspace projects
description: List teamspace projects via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration, projects, project management
keywords: plane api, teamspace projects, team project management, team collaboration, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/list-teamspaces.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List all teamspaces
description: List all teamspaces via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, list teamspaces, get all teams, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: Plane Teamspace API overview. Learn about endpoints, request/response format, and how to work with teamspace via REST API.
keywords: plane, plane api, rest api, api integration
keywords: plane api, teamspace, team management, team collaboration, workspace teams, rest api, api integration
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Remove projects from teamspace
description: Delete projects from teamspace via Plane API. HTTP DELETE request for removing resources.
keywords: plane, plane api, rest api, api integration, projects, project management
keywords: plane api, remove projects from teamspace, team project management, team collaboration, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/remove-teamspace-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Remove members from teamspace
description: Delete members from teamspace via Plane API. HTTP DELETE request for removing resources.
keywords: plane, plane api, rest api, api integration
keywords: plane api, remove teamspace members, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/teamspace/update-teamspace-detail.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Update a teamspace
description: Update a teamspace via Plane API. HTTP PATCH request format, editable fields, and example responses.
keywords: plane, plane api, rest api, api integration
keywords: plane api, update teamspace, modify team, team management, workspace teams, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/user/get-current-user.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Retrieve current user
description: List retrieve current user via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords: plane, plane api, rest api, api integration
keywords: plane api, get current user, user profile, authenticated user, user details, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/user/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: Plane User API overview. Learn about endpoints, request/response format, and how to work with user via REST API.
keywords: plane, plane api, rest api, api integration
keywords: plane api, user profile, current user, user account, authentication, rest api, api integration
---


Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/worklogs/delete-worklog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete a worklog
description: Delete a worklog via Plane API. HTTP DELETE request for removing resources.
description: Delete a time tracking worklog entry via Plane API. Removes the logged time from the work item. Returns 204 on success.
keywords: plane, plane api, rest api, api integration, time tracking, worklogs, time management
---

Expand Down
5 changes: 3 additions & 2 deletions docs/dev-tools/agents/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Best practices
description: Guidelines for building responsive, user-friendly Plane agents that provide a seamless experience.
title: Agent best practices
description: Guidelines for building responsive, user-friendly Plane agents that provide a seamless experience. Covers error handling, response patterns, and user communication.
keywords: plane agent best practices, agent design patterns, plane bot guidelines, agent error handling, responsive agents, plane agent development
---

# Best practices
Expand Down
Loading
Loading