Skip to content

Clarify API docs for triage endpoint and S3 configuration#2216

Merged
jorgemanrubia merged 3 commits intobasecamp:mainfrom
creslinux:docs/clarify-triage-endpoint
Mar 3, 2026
Merged

Clarify API docs for triage endpoint and S3 configuration#2216
jorgemanrubia merged 3 commits intobasecamp:mainfrom
creslinux:docs/clarify-triage-endpoint

Conversation

@creslinux
Copy link
Copy Markdown
Contributor

Two small documentation clarifications:

  1. API.md - The triage endpoint documentation says "Moves a card from triage into a column" which implies it only works for cards in triage. The implementation works for cards in any state, so updated to clarify.

  2. docker-deployment.md / kamal-deployment.md - Added CSP_CONNECT_SRC to the S3 configuration section. Without this, browser Content Security Policy blocks direct uploads to S3.

Copilot AI review requested due to automatic review settings March 3, 2026 10:42
@jorgemanrubia
Copy link
Copy Markdown
Member

I think we can just remove the extra sentence — "Moves a card into a column." feels sufficient on its own.

@jorgemanrubia jorgemanrubia merged commit ffb80ea into basecamp:main Mar 3, 2026
2 checks passed
@jorgemanrubia
Copy link
Copy Markdown
Member

Thanks for the contribution! Good catches on both the triage endpoint description and the CSP docs.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only PR that clarifies the behavior of the card triage API endpoint and documents an additional CSP environment variable needed for S3 direct uploads in container-based deployments.

Changes:

  • Update API docs to describe the triage endpoint as moving a card into a column (not only from triage).
  • Add CSP_CONNECT_SRC to the documented S3-related environment variables for Docker and Kamal deployments.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/kamal-deployment.md Documents CSP_CONNECT_SRC alongside S3 env vars for Kamal deployments.
docs/docker-deployment.md Documents CSP_CONNECT_SRC alongside S3 env vars for Docker deployments.
docs/API.md Clarifies the POST .../triage endpoint description to match actual behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

3 participants