Skip to content

docs: updates for PR #730#736

Open
dosubot[bot] wants to merge 1 commit intocanaryfrom
dosu/doc-update-730
Open

docs: updates for PR #730#736
dosubot[bot] wants to merge 1 commit intocanaryfrom
dosu/doc-update-730

Conversation

@dosubot
Copy link

@dosubot dosubot bot commented Mar 5, 2026

Update documentation for #730

Generated by Dosu

Greptile Summary

This PR updates .github/copilot-instructions.md to clarify the port-mapping policy introduced in PR #730: blueprints must use expose instead of ports with host mappings, and this is now stated explicitly ("NEVER use ports with host port mappings") in three places—the key files section, the development workflow, and the conventions section.

  • The changes are internally consistent and align with the existing AGENTS.md guidance (line 150: "NEVER include: ports (use expose only)").
  • The expanded Conventions section now explains why host port bindings are prohibited (Dokploy's internal reverse proxy handles routing) and notes that older templates may still incorrectly use ports.
  • One inaccuracy found: line 27 states the exemplary Ghost blueprint's docker-compose.yml "uses expose: ["2368"] for port exposure", but blueprints/ghost/docker-compose.yml contains no expose directive at all—Ghost's port is handled entirely via template.toml's domain configuration. Since this line is labelled as the reference example for AI agents, the inaccuracy should be corrected.

Confidence Score: 4/5

  • Documentation-only PR that is safe to merge after fixing a factual inaccuracy in the exemplary blueprint description.
  • Only one file is changed and the changes are documentation. The core guidance is correct and consistent with AGENTS.md. A single factual inaccuracy (claiming Ghost's docker-compose.yml uses expose: ["2368"] when it does not) lowers the score slightly because this file serves as an AI collaboration guide and inaccurate examples can mislead generated blueprints.
  • .github/copilot-instructions.md — line 27 contains an inaccurate claim about the Ghost blueprint's use of expose.

Last reviewed commit: 92020b2

Greptile also left 1 inline comment on this PR.

(4/5) You can add custom instructions or style guidelines for the agent here!

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Mar 5, 2026
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
templates ✅ Ready (View Log) Visit Preview 92020b2

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 5, 2026
- `build-scripts/process-meta.js`: Advanced processor with CLI options (`--verbose`, `--no-backup`, `--input`/`--output`), JSON schema validation (required: `id`, `name`, `version`, `description`, `links.github`, `logo`, `tags` array).

Exemplary blueprint: `blueprints/ghost/`—`docker-compose.yml` exposes port 2368; `template.toml` maps domain to Ghost service; meta entry tags as ["blogging", "cms"].
Exemplary blueprint: `blueprints/ghost/`—`docker-compose.yml` uses `expose: ["2368"]` for port exposure; `template.toml` maps domain to Ghost service; meta entry tags as ["blogging", "cms"].
Copy link

Choose a reason for hiding this comment

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

Inaccurate exemplary blueprint description

The updated description says blueprints/ghost/docker-compose.yml uses expose: ["2368"] for port exposure, but the actual file contains no expose directive at all. Ghost's port 2368 is handled purely through the template.toml domain configuration (port = 2_368), not via an explicit expose entry in the compose file. Since this line is presented as the canonical example for AI agents to follow, an inaccurate claim here could cause generated blueprints to be structured incorrectly.

Consider updating the line to reflect what the blueprint actually does:

Suggested change
Exemplary blueprint: `blueprints/ghost/``docker-compose.yml` uses `expose: ["2368"]` for port exposure; `template.toml` maps domain to Ghost service; meta entry tags as ["blogging", "cms"].
Exemplary blueprint: `blueprints/ghost/``docker-compose.yml` defines the service (port proxied by Dokploy via `template.toml`); `template.toml` maps domain to Ghost service on port 2368; meta entry tags as ["blogging", "cms"].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants