Skip to content

Commit cde8fe3

Browse files
authored
fix: consolidate template README images into single directory (#193)
## Description This PR moves all the existing template README images for the Coder namespace from being defined inline to its `.images` directory. This makes the image-processing logic in the Registry build step easier to maintain. ## Type of Change - [ ] New module - [x] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [ ] Other ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun run fmt`) - [x] Changes tested locally --- ## Related Issues Related to #132
1 parent 6999623 commit cde8fe3

File tree

7 files changed

+230
-12
lines changed

7 files changed

+230
-12
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
Closes #
2+
13
## Description
24

35
<!-- Briefly describe what this PR does and why -->
46

5-
---
6-
77
## Type of Change
88

99
- [ ] New module
@@ -12,8 +12,6 @@
1212
- [ ] Documentation
1313
- [ ] Other
1414

15-
---
16-
1715
## Module Information
1816

1917
<!-- Delete this section if not applicable -->
@@ -22,18 +20,12 @@
2220
**New version:** `v1.0.0`
2321
**Breaking change:** [ ] Yes [ ] No
2422

25-
---
26-
2723
## Testing & Validation
2824

2925
- [ ] Tests pass (`bun test`)
3026
- [ ] Code formatted (`bun run fmt`)
3127
- [ ] Changes tested locally
3228

33-
---
34-
3529
## Related Issues
3630

3731
<!-- Link related issues or write "None" if not applicable -->
38-
39-
Closes #

pnpm-lock.yaml

Lines changed: 220 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

registry/coder/modules/local-windows-rdp/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ tags: [rdp, windows, desktop, local]
1212

1313
This module enables Remote Desktop Protocol (RDP) on Windows workspaces and adds a one-click button to launch RDP sessions directly through [Coder Desktop](https://coder.com/docs/user-guides/desktop). It provides a complete, standalone solution for RDP access, eliminating the need for manual configuration or port forwarding through the Coder CLI.
1414

15+
<!--
16+
2025-07-07 - Prettier isn't formatting GFM comments properly if they don't
17+
start with a letter.
18+
See https://github.com/prettier/prettier/issues/15479
19+
-->
20+
<!-- prettier-ignore -->
1521
> [!NOTE]
1622
> [Coder Desktop](https://coder.com/docs/user-guides/desktop) is required on client devices to use the Local Windows RDP access feature.
1723

registry/coder/templates/aws-devcontainer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ tags: [vm, linux, aws, persistent, devcontainer]
1010
# Remote Development on AWS EC2 VMs using a Devcontainer
1111

1212
Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs) with this example template.
13-
![Architecture Diagram](./architecture.svg)
13+
![Architecture Diagram](../../.images/aws-devcontainer-architecture.svg)
1414

1515
<!-- TODO: Add screenshot -->
1616

registry/coder/templates/gcp-devcontainer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: [vm, linux, gcp, devcontainer]
99

1010
# Remote Development in a Devcontainer on Google Compute Engine
1111

12-
![Architecture Diagram](./architecture.svg)
12+
![Architecture Diagram](../../.images/gcp-devcontainer-architecture.svg)
1313

1414
## Prerequisites
1515

0 commit comments

Comments
 (0)