fix(api, integrations): use keys instead of titles, fixed broken images, ToC depth#55
fix(api, integrations): use keys instead of titles, fixed broken images, ToC depth#55yxL05 wants to merge 8 commits into
Conversation
yxL05
commented
Jun 16, 2026
- Fixed request / response descriptions in API docs using the title instead of the object key
- Fixed broken images in integration guides that used the built-in HTML img instead of Astro Pictures
- Fixed table of content depth to match old docs
Greptile SummaryThis PR addresses three distinct doc-site issues: API request/response field names now display the schema key rather than the human-readable
Confidence Score: 4/5Safe to merge — all changes are documentation and UI component fixes with no runtime logic at risk. The core fixes (key-based field names, Astro Picture migration, ToC depth) are mechanical and low-risk. The new Definition/DefinitionReference components work correctly for every term used in this PR. The two minor points are the hardcoded SVG fill colour and the naive pluralization guard, neither of which causes a rendering failure today. src/components/DefinitionReference.astro (pluralization edge case) and src/components/icons/plugins/FileSynchronizerIcon.astro (hardcoded colour). Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["DefinitionList.astro\n(dl wrapper)"] --> B["Definition.astro\n(dt + dd + id anchor)"]
C["DefinitionReference.astro\n(a href='#id')"] -->|"links to"| B
D["MDX page\n(implementing-hitl / file-sync)"] -->|"renders"| A
D -->|"renders"| C
E["SchemaFields.tsx"] -->|"key (was prop.title)"| F["API field name displayed"]
G["img src"] -->|"replaced by"| H["Picture src={imported}"]
H -->|"processed by"| I["astro:assets optimizer"]
J["cleanup-headings.ts\nTOKEN_RE #{2,4}"] -->|"feeds"| K["ToC depth <= 4\n(was <= 3)"]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A["DefinitionList.astro\n(dl wrapper)"] --> B["Definition.astro\n(dt + dd + id anchor)"]
C["DefinitionReference.astro\n(a href='#id')"] -->|"links to"| B
D["MDX page\n(implementing-hitl / file-sync)"] -->|"renders"| A
D -->|"renders"| C
E["SchemaFields.tsx"] -->|"key (was prop.title)"| F["API field name displayed"]
G["img src"] -->|"replaced by"| H["Picture src={imported}"]
H -->|"processed by"| I["astro:assets optimizer"]
J["cleanup-headings.ts\nTOKEN_RE #{2,4}"] -->|"feeds"| K["ToC depth <= 4\n(was <= 3)"]
Reviews (1): Last reviewed commit: "More broken images fixes." | Re-trigger Greptile |