Skip to content

docs: basic spec for TypeScript SDK#64

Merged
Pertempto merged 5 commits intomainfrom
18-typescript-sdk
Oct 24, 2025
Merged

docs: basic spec for TypeScript SDK#64
Pertempto merged 5 commits intomainfrom
18-typescript-sdk

Conversation

@Pertempto
Copy link
Copy Markdown
Contributor

First PR for #18

  • Added basic spec for the SDK

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 24, 2025

Changes Requested

  • Update CHANGELOG.md with an entry for this PR, following the existing format (e.g., link to PR docs: basic spec for TypeScript SDK #64, keep under 5 lines).
  • @Pertempto, please confirm if the docker-compose.yml change regarding port mapping was intentional. The current file still exposes the service via ports: - "8765:8080", but the comment suggested removal—clarify for consistency in local dev access.

Summary of Changes

  • Updated AGENTS.md with more precise guidelines for issue specifications, emphasizing atomic PRs with conventional commit titles.
  • Added new docker-compose.coolify.yml for Coolify platform deployments with exposed port 8080 and volumes.
  • Simplified docker-compose.yml by removing unused network and named volume configurations.
  • Modified README.md to remove outdated notes on volume switching options.
  • Added specs/18-typescript-sdk.md outlining a structured plan for building the TypeScript SDK, including API spec, generation, tests, and CI integration.

Overall Feedback

Forgot the CHANGELOG update again—can't merge without it, especially for new docs that impact project planning. 🚨 Also, the CD setup needs clarification to avoid dev workflow hiccups. But hey, the spec is super detailed and atomically planned, love the TDD vibe! 👍 This will make implementing the SDK a breeze once those bits are squared.

@github-actions
Copy link
Copy Markdown
Contributor

Regarding the docker-compose.yml change, removing the port mapping - "8765:8080" and only exposing - "8080" means the service won't be accessible from your host machine directly (unless using --publish-all). If local development access is needed, consider uncommenting the suggested mapping. Was this change intentional?

@Pertempto Pertempto merged commit 6dd4c89 into main Oct 24, 2025
2 checks passed
@Pertempto Pertempto deleted the 18-typescript-sdk branch October 24, 2025 01:01
@github-actions
Copy link
Copy Markdown
Contributor

Regarding the docker-compose.yml change, removing the port mapping - \"8765:8080\" and only exposing - \"8080\" means the service won't be accessible from your host machine directly (unless using --publish-all). If local development access is needed, consider uncommenting the suggested mapping. Was this change intentional?

@Pertempto, to respond to the bot's question: the current docker-compose.yml still includes the port mapping ports: - "8765:8080", so it seems unchanged in that regard. If the diff suggests otherwise, please clarify if this was intentional—local development typically requires host access to the service.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Regarding the docker-compose.yml change, removing the port mapping - \"8765:8080\" and only exposing - \"8080\" means the service won't be accessible from your host machine directly (unless using --publish-all). If local development access is needed, consider uncommenting the suggested mapping. Was this change intentional?

@Pertempto, to respond to the bot's question: the current docker-compose.yml still includes the port mapping ports: - "8765:8080", so it seems unchanged in that regard. If the diff suggests otherwise, please clarify if this was intentional—local development typically requires host access to the service.

@github-actions
Copy link
Copy Markdown
Contributor

Regarding the docker-compose.yml change, removing the port mapping - \""8765:8080\"" and only exposing - \""8080\"" means the service won't be accessible from your host machine directly (unless using --publish-all). If local development access is needed, consider uncommenting the suggested mapping. Was this change intentional?

@Pertempto, to respond to the bot's question: the current docker-compose.yml still includes the port mapping ports: - "8765:8080", so it seems unchanged in that regard. If the diff suggests otherwise, please clarify if this was intentional—local development typically requires host access to the service.

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.

1 participant