|
1 | | - For all mdx/md files in @docs/canary-checker/ and @docs/mission-control/ that have `<!-- Source: ... -->` comments pointing to Go source files: |
| 1 | +For all mdx/md files in @docs/canary-checker/ and @docs/mission-control/ that have `<!-- Source: ... -->` comments pointing to Go source files: |
2 | 2 |
|
3 | | - 1. Update the Source comments to use `#StructName` format without line numbers (e.g., `checks.go#HTTPCheck` not `checks.go:117#HTTPCheck`) |
| 3 | +1. Update the Source comments to use `#StructName` format without line numbers (e.g., `checks.go#HTTPCheck` not `checks.go:117#HTTPCheck`) |
4 | 4 |
|
5 | | - 2. For each documented struct, compare ALL public fields from the Go source against the documentation and: |
6 | | - - Add any missing fields |
7 | | - - Fix incorrect field names (check json/yaml tags - use the json/yaml tag name, not the Go field name) |
8 | | - - If json/yaml tag differ from each other, warn user |
9 | | - - Fix incorrect schemes/types (e.g., `Duration` vs `int`, `bool` vs `string`) |
10 | | - - Fix incorrect nested structures (check if fields are inline or nested under a parent key) |
11 | | - - Remove fields that don't exist in the Go struct |
12 | | - - For inline embedded structs, verify which fields they provide |
| 5 | +2. For each documented struct, compare ALL public fields from the Go source against the documentation and: |
| 6 | + - Add any missing fields |
| 7 | + - Fix incorrect field names (check json/yaml tags - use the json/yaml tag name, not the Go field name) |
| 8 | + - If json/yaml tag differ from each other, warn user |
| 9 | + - Fix incorrect schemes/types (e.g., `Duration` vs `int`, `bool` vs `string`) |
| 10 | + - Fix incorrect nested structures (check if fields are inline or nested under a parent key) |
| 11 | + - Remove fields that don't exist in the Go struct |
| 12 | + - For inline embedded structs, verify which fields they provide |
13 | 13 |
|
14 | | - 3. For _canary-spec.mdx, ensure all check types from CanarySpec are listed with correct field names matching the json/yaml tags |
| 14 | +3. For \_canary-spec.mdx, ensure all check types from CanarySpec are listed with correct field names matching the json/yaml tags |
15 | 15 |
|
16 | | - Pay attention to: |
17 | | - - yaml tags like `yaml:"env"` mean the field name in docs should be `env`, not the Go field name |
18 | | - - Inline embedded structs (e.g., `Connection`, `Description`, `Templatable`) - their fields appear at the same level |
19 | | - - Pointer vs value types for nested structs |
20 | | - - Deprecated fields should be marked as such |
21 | | - - ignore private fields |
| 16 | +Pay attention to: |
22 | 17 |
|
| 18 | +- yaml tags like `yaml:"env"` mean the field name in docs should be `env`, not the Go field name |
| 19 | +- Inline embedded structs (e.g., `Connection`, `Description`, `Templatable`) - their fields appear at the same level |
| 20 | +- Pointer vs value types for nested structs |
| 21 | +- Deprecated fields should be marked as such |
| 22 | +- ignore private fields |
0 commit comments