⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.
TypeScript honoissue-managementissue-trackerjira-alternativekanbanlinear-alternativemcpproject-managementreactself-hostedtypescript
docs: describe the new settings pages
Andrejb7e8190dd8f8
diff --git a/apps/docs/core/functional/configure-workflows.mdx b/apps/docs/core/functional/configure-workflows.mdxindex 7a5c5d712..fb7214765 100644--- a/apps/docs/core/functional/configure-workflows.mdx+++ b/apps/docs/core/functional/configure-workflows.mdx@@ -1,33 +1,39 @@---title: "Workflows"-description: "Choose project columns and map repository events to the right status."+description: "Choose project columns, add custom fields, and map repository events to the right status."---Open **Settings → Projects**, select a project, and choose **Workflow**. You need permission to manage the project to change its columns.## Change the columns-In **Columns**, add a stage, rename an existing one, choose its icon, or drag it into a different order. Start with the few stages your team actually uses, such as **To Do → In Progress → Review → Done**.+In **Columns**, add a stage with **Add column**, click a name to rename it, click its icon to choose another, or drag a row into a different order. Start with the few stages your team actually uses, such as **To Do → In Progress → Review → Done**.-Mark a column as a final state when tasks in it should count as complete. A column's name alone does not define completion.+Turn on **Done** for a column when tasks in it should count as complete. A column's name alone does not define completion.-<Frame caption="Project workflow settings contain columns, custom fields, and integration automation.">- <img className="block dark:hidden" src="/images/product/workflow-light.png" alt="Project workflow settings contain columns, custom fields, and integration automation." />- <img className="hidden dark:block" src="/images/product/workflow-dark.png" alt="Project workflow settings contain columns, custom fields, and integration automation." />+<Frame caption="Project workflow settings contain columns and automations.">+ <img className="block dark:hidden" src="/images/product/workflow-light.png" alt="Project workflow settings contain columns and automations." />+ <img className="hidden dark:block" src="/images/product/workflow-dark.png" alt="Project workflow settings contain columns and automations." /></Frame>-Kaneo refuses to delete a column that still contains tasks. Move those tasks into another column first and check any automation rules that target it. Changes apply to the whole project, so let your teammates know before reorganizing an active board.+Kaneo asks before deleting a column and refuses to delete one that still contains tasks. Move those tasks into another column first and check any automations that target it. Changes apply to the whole project, so let your teammates know before reorganizing an active board.-## Add custom fields+## Set up custom fields-Use **Custom Fields** on the same page when tasks need another piece of structured information. Give each field a clear name and choose text, number, date, dropdown, or boolean. For a dropdown, define the available choices. Drag fields to change their order; task details show them under **Custom Fields**.+Open **Custom fields** under the same project when tasks need another piece of structured information. Select **New field**, choose text, number, date, dropdown, or checkbox, and give it a clear name. For a dropdown, add the available options, and turn on **Allow several** if a task can pick more than one. Turn on **Required** to give every task a value; a required field needs a default, which Kaneo also fills in on existing tasks that have none.++Drag fields to change their order. Task details show them under **Custom fields**.++To change a field, open its menu and select **Edit**. You can rename it, change its default, make it required, and add or reorder options. The type cannot change after a field is created, except switching a dropdown between one and several options. Kaneo refuses to remove or rename an option that tasks still use, and to turn off **Allow several** while a task has more than one option selected, so existing values never change silently.++Deleting a field removes it and its value from every task.## Move tasks automatically-Under **Automation Rules**, choose a target column for each GitHub or Gitea event you want to use. For example, a branch push can move work to **In Progress**, and a merged pull request can move it to **Done**.+Under **Automations**, each connected GitHub, Gitea, or GitLab repository has its own list of events. Choose a target column for each event you want to use. For example, a branch push can move work to **In Progress**, and a merged pull request can move it to **Done**. Choose **Don't move** to stop using an event.Connect the repository first through [Integrations](/core/integrations/index). Test one event with a task whose branch name matches the integration's pattern, then confirm the task moves to the expected column.-To change a mapping, select another column. Disconnect the repository integration if you want to stop using that connection entirely.+Disconnect the repository integration if you want to stop using that connection entirely.Return to [Board and List](/core/functional/plan-and-execute-tasks) to work with the updated columns.diff --git a/apps/docs/core/functional/manage-your-account.mdx b/apps/docs/core/functional/manage-your-account.mdxindex a5a4f2364..e93ae6016 100644--- a/apps/docs/core/functional/manage-your-account.mdx+++ b/apps/docs/core/functional/manage-your-account.mdx@@ -3,20 +3,20 @@ title: Your accountdescription: Manage your profile, password, API keys, and account deletion----Your profile picture and your account itself are both managed from **Settings -> Account -> Information**.+Your profile picture and your account itself are both managed from **Settings → Account → Profile**.## Change your profile picture1. Go to **Settings**.-2. Open **Account -> Information**.-3. Click your picture and choose **Change avatar**.+2. Open **Account → Profile**.+3. Next to **Profile picture**, select **Upload**.4. Pick any image. It is cropped to a square and resized to 256x256 before it is uploaded.-Choose **Remove avatar** to go back to your initials. Pictures are stored in your Kaneo database, so self-hosted instances need no object storage for this and a normal database backup includes them.+Select **Remove** to go back to your initials. Pictures are stored in your Kaneo database, so self-hosted instances need no object storage for this and a normal database backup includes them.## Change your password-Open **Settings → Account → Security**. If your account has a password, enter the current password, choose a new one, and confirm it. The new password must be between 8 and 128 characters.+Open **Settings → Account → Security** and select **Change password**. Enter the current password, choose a new one, and confirm it. The new password must be between 8 and 128 characters.Accounts that sign in only through a provider or passwordless email do not have a current password to change here. If you forgot an existing password, use **Forgot password?** on the password sign-in form. Reset emails require SMTP and local sign-in to be enabled by your instance operator. Reset links expire after one hour; completing a reset revokes existing sessions.@@ -27,12 +27,12 @@ Accounts that sign in only through a provider or passwordless email do not have## API keys-Open **Settings → Account → API Keys** to create or revoke credentials for scripts and integrations. Follow [API authentication](/api-reference/authentication) before using a key.+Open **Settings → Account → API keys** to create or delete credentials for scripts and integrations. Follow [API authentication](/api-reference/authentication) before using a key.## Delete your account1. Go to **Settings**.-2. Open **Account -> Information**.+2. Open **Account → Profile**.3. Under **Danger zone**, select **Delete account**.4. Type your email address to confirm, then select **Delete account**.@@ -47,8 +47,8 @@ Deleting your account cannot be undone.### When deletion is refused-- **You are the only owner of a shared workspace.** Transfer ownership from **Settings -> Workspace -> General**, or delete the workspace first.-- **A workspace still has an active subscription.** Cancel it under **Settings -> Workspace -> Billing** first, so you are not charged for a workspace you can no longer reach.+- **You are the only owner of a shared workspace.** Transfer ownership from **Settings → Workspace → General**, or delete the workspace first.+- **A workspace still has an active subscription.** Cancel it under **Settings → Workspace → Billing** first, so you are not charged for a workspace you can no longer reach.- **You signed in a while ago.** For security, sign out and sign back in, then try again.<Note>diff --git a/apps/docs/core/functional/plan-and-execute-tasks.mdx b/apps/docs/core/functional/plan-and-execute-tasks.mdxindex 5ab67e5b0..3b2e18a27 100644--- a/apps/docs/core/functional/plan-and-execute-tasks.mdx+++ b/apps/docs/core/functional/plan-and-execute-tasks.mdx@@ -64,7 +64,7 @@ Use **Remove relation** to unlink the tasks without deleting either task.## Fill in custom fields-If your project defines extra fields, open **Custom Fields** in task details. These can hold text, numbers, dates, dropdown choices, or a yes/no value. A project manager defines the fields in [Workflow settings](/core/functional/configure-workflows).+If your project defines extra fields, open **Custom Fields** in task details. These can hold text, numbers, dates, dropdown choices, or a yes/no value. A project manager defines the fields in [Custom fields settings](/core/functional/configure-workflows#set-up-custom-fields).## Delete a taskdiff --git a/apps/docs/core/integrations/github/configuration.mdx b/apps/docs/core/integrations/github/configuration.mdxindex 60f33750b..bd2b82398 100644--- a/apps/docs/core/integrations/github/configuration.mdx+++ b/apps/docs/core/integrations/github/configuration.mdx@@ -28,12 +28,13 @@ For Kubernetes, pass the same values through a Secret using your deployment's ex## Connect the project-1. Open **Settings → Projects**, select the project, then open **Integrations**.-2. In GitHub, browse the repositories available to your installed app, or enter the owner and repository name.-3. Verify the installation and connect the repository.-4. Create a test task and check that its GitHub issue appears.+1. Open **Settings → Projects**, select the project, then open **Integrations** and select **Connect** next to GitHub.+2. Link your GitHub account if Kaneo asks for it. Kaneo uses it to confirm that you administer the repository.+3. Type the repository as `owner/name`, or select **Browse** and search the repositories your installed app can reach. Kaneo checks the installation as soon as you pick one.+4. Select **Connect repository**.+5. Create a test task and check that its GitHub issue appears.-Use a test repository for the first check, since synchronization creates real issues and comments. Review the event-to-column mappings under **Workflow → Automation Rules**.+Use a test repository for the first check, since synchronization creates real issues and comments. Review the event-to-column mappings under **Workflow → Automations**.### Changing the connected repository@@ -144,7 +145,7 @@ Customize when tasks automatically change status:| PR Opened | `in-review` | ✅ || PR Merged | `done` | ✅ |-Configure these in your project's GitHub integration settings to match your workflow.+Configure these under **Workflow → Automations** to match your workflow.<Warning>A completed task moves again only when new work starts on it: the first push to a branch that is not yet linked to the task, or a pull request that is not yet linked to it. More pushes to a linked branch, or reopening a pull request, leave a completed task where it is.@@ -175,7 +176,7 @@ If you need to connect repositories from multiple GitHub organizations:## Import existing issues-Select **Import Issues** in the project's GitHub integration settings to import open issues and their labels and comments. Existing linked tasks are updated; matching open pull requests are linked to their tasks. Bot comments are excluded.+Select **Import issues** in the project's GitHub integration settings to import open issues and their labels and comments. Existing linked tasks are updated; matching open pull requests are linked to their tasks. Bot comments are excluded.Large imports run in small, sequential steps. Keep the page open until the completion message appears. If the connection fails or you close the page, the saved progress remains available: return to these settings and select **Resume import**. The completion message lists created, updated and skipped issues. A skipped issue may have lost its source or linked task during the import, or have a legacy link to another project.diff --git a/apps/docs/core/integrations/github/troubleshooting.mdx b/apps/docs/core/integrations/github/troubleshooting.mdxindex 59f3ddf2e..629b390dd 100644--- a/apps/docs/core/integrations/github/troubleshooting.mdx+++ b/apps/docs/core/integrations/github/troubleshooting.mdx@@ -54,7 +54,7 @@ Then check:1. The app can read pull requests and repository contents.2. Push and pull-request events are subscribed and arriving.-3. **Workflow → Automation Rules** maps the event to the intended column.+3. **Workflow → Automations** maps the event to the intended column.4. The task is eligible for the transition. A completed task only moves for new work: a branch or pull request that is not yet linked to it.Try one branch push and inspect its webhook delivery before testing another event.diff --git a/apps/docs/core/migrations/from-kaneo.mdx b/apps/docs/core/migrations/from-kaneo.mdxindex 924559a97..ea74cc4a9 100644--- a/apps/docs/core/migrations/from-kaneo.mdx+++ b/apps/docs/core/migrations/from-kaneo.mdx@@ -11,7 +11,7 @@ You need:- To be an admin of the Kaneo workspace you are importing into.- The URL of the other instance, for example `https://cloud.kaneo.app`.-- An API key created on the other instance. Sign in there and open **Settings → Account → API Keys**.+- An API key created on the other instance. Sign in there and open **Settings → Account → API keys**.Invite your team to the workspace you are importing into first. Assignees are matched by email, so anyone who isn't a member yet will have their tasks imported unassigned.diff --git a/apps/docs/core/migrations/from-planka.mdx b/apps/docs/core/migrations/from-planka.mdxindex 71f1062e2..c51f7d74f 100644--- a/apps/docs/core/migrations/from-planka.mdx+++ b/apps/docs/core/migrations/from-planka.mdx@@ -73,7 +73,7 @@ Use it if you prefer the terminal, want to script the migration, or your PLANKA### Requirements- A PLANKA account that can see the boards you want to move. If you sign in through SSO and have no password, create a PLANKA API key and use `--planka-api-key`.-- A Kaneo workspace, and an API key from **Settings → Account → API Keys**.+- A Kaneo workspace, and an API key from **Settings → Account → API keys**.- Node.js 20 or newer.As with the in-app import, use a PLANKA admin account to keep assignees, and invite your team to the Kaneo workspace first.