@cleocode/cleo 2026.3.4 → 2026.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/dist/cli/index.js +2277 -609
  2. package/dist/cli/index.js.map +4 -4
  3. package/dist/mcp/index.js +1838 -443
  4. package/dist/mcp/index.js.map +4 -4
  5. package/package.json +1 -1
  6. package/packages/ct-skills/index.js +1 -1
  7. package/packages/ct-skills/package.json +0 -2
  8. package/packages/ct-skills/profiles/core.json +1 -1
  9. package/packages/ct-skills/profiles/full.json +4 -5
  10. package/packages/ct-skills/profiles/minimal.json +3 -3
  11. package/packages/ct-skills/profiles/recommended.json +2 -2
  12. package/packages/ct-skills/provider-skills-map.json +97 -0
  13. package/packages/ct-skills/skills/_shared/skill-chaining-patterns.md +23 -26
  14. package/packages/ct-skills/skills/_shared/testing-framework-config.md +9 -9
  15. package/packages/ct-skills/skills/ct-cleo/SKILL.md +21 -1
  16. package/packages/ct-skills/skills/ct-dev-workflow/SKILL.md +1 -1
  17. package/packages/ct-skills/skills/ct-documentor/SKILL.md +1 -1
  18. package/packages/ct-skills/skills/ct-epic-architect/SKILL.md +1 -1
  19. package/packages/ct-skills/skills/ct-orchestrator/SKILL.md +119 -43
  20. package/packages/ct-skills/skills/ct-orchestrator/orchestrator-prompt.txt +17 -0
  21. package/packages/ct-skills/skills/ct-orchestrator/references/orchestrator-patterns.md +1 -1
  22. package/packages/ct-skills/skills/ct-research-agent/SKILL.md +1 -1
  23. package/packages/ct-skills/skills/ct-spec-writer/SKILL.md +1 -1
  24. package/packages/ct-skills/skills/ct-task-executor/SKILL.md +1 -1
  25. package/packages/ct-skills/skills/ct-validator/SKILL.md +1 -1
  26. package/packages/ct-skills/skills/manifest.json +217 -947
  27. package/packages/ct-skills/skills.json +244 -3
  28. package/server.json +4 -4
  29. package/templates/CLEO-INJECTION.md +24 -0
  30. package/packages/ct-skills/protocols/agent-protocol.md +0 -260
  31. package/packages/ct-skills/protocols/artifact-publish.md +0 -587
  32. package/packages/ct-skills/protocols/consensus.md +0 -309
  33. package/packages/ct-skills/protocols/contribution.md +0 -375
  34. package/packages/ct-skills/protocols/decomposition.md +0 -352
  35. package/packages/ct-skills/protocols/implementation.md +0 -344
  36. package/packages/ct-skills/protocols/provenance.md +0 -600
  37. package/packages/ct-skills/protocols/release.md +0 -635
  38. package/packages/ct-skills/protocols/research.md +0 -248
  39. package/packages/ct-skills/protocols/specification.md +0 -287
  40. package/packages/ct-skills/protocols/testing.md +0 -346
  41. package/packages/ct-skills/protocols/validation.md +0 -229
  42. package/packages/ct-skills/skills/ct-gitbook/SKILL.md +0 -516
  43. package/packages/ct-skills/skills/ct-gitbook/assets/SUMMARY.md +0 -28
  44. package/packages/ct-skills/skills/ct-gitbook/assets/gitbook.yaml +0 -14
  45. package/packages/ct-skills/skills/ct-gitbook/references/api-sdk.md +0 -318
  46. package/packages/ct-skills/skills/ct-gitbook/references/auth-sso.md +0 -208
  47. package/packages/ct-skills/skills/ct-gitbook/references/change-requests.md +0 -169
  48. package/packages/ct-skills/skills/ct-gitbook/references/content-blocks.md +0 -230
  49. package/packages/ct-skills/skills/ct-gitbook/references/docs-sites.md +0 -202
  50. package/packages/ct-skills/skills/ct-gitbook/references/git-sync.md +0 -175
  51. package/packages/ct-skills/skills/ct-gitbook/references/llm-ready.md +0 -178
  52. package/packages/ct-skills/skills/ct-gitbook/references/migration.md +0 -263
  53. package/packages/ct-skills/skills/ct-library-implementer-bash/SKILL.md +0 -316
  54. package/packages/ct-skills/skills/ct-skill-lookup/SKILL.md +0 -179
  55. package/packages/ct-skills/skills/ct-test-writer-bats/SKILL.md +0 -347
  56. package/packages/ct-skills/skills/railway-platform/SKILL.md +0 -506
  57. package/packages/ct-skills/skills/railway-platform/_shared/scripts/railway-api.sh +0 -180
  58. package/packages/ct-skills/skills/railway-platform/_shared/scripts/railway-common.sh +0 -262
  59. package/packages/ct-skills/skills/railway-platform/references/01-getting-started.md +0 -149
  60. package/packages/ct-skills/skills/railway-platform/references/02-projects.md +0 -116
  61. package/packages/ct-skills/skills/railway-platform/references/03-services.md +0 -147
  62. package/packages/ct-skills/skills/railway-platform/references/04-deployments.md +0 -210
  63. package/packages/ct-skills/skills/railway-platform/references/05-databases.md +0 -142
  64. package/packages/ct-skills/skills/railway-platform/references/06-environments.md +0 -261
  65. package/packages/ct-skills/skills/railway-platform/references/07-domains.md +0 -139
  66. package/packages/ct-skills/skills/railway-platform/references/08-volumes.md +0 -533
  67. package/packages/ct-skills/skills/railway-platform/references/09-networking.md +0 -592
  68. package/packages/ct-skills/skills/railway-platform/references/10-cron.md +0 -488
  69. package/packages/ct-skills/skills/railway-platform/references/11-functions.md +0 -170
  70. package/packages/ct-skills/skills/railway-platform/references/12-monorepo.md +0 -294
  71. package/packages/ct-skills/skills/railway-platform/references/13-troubleshooting.md +0 -335
  72. package/packages/ct-skills/skills/railway-platform/references/14-railway-metal.md +0 -197
@@ -1,230 +0,0 @@
1
- # Content Blocks Reference
2
-
3
- Content types, OpenAPI integration, embeds, and Markdown extensions in GitBook.
4
-
5
- ## Overview
6
-
7
- GitBook's block-based editor supports rich content beyond standard Markdown. When using Git Sync, special syntax and templates map to these blocks.
8
-
9
- ## Block Types
10
-
11
- ### Code Blocks
12
-
13
- Standard fenced code blocks with syntax highlighting:
14
-
15
- ````markdown
16
- ```typescript
17
- const x = 42;
18
- ```
19
- ````
20
-
21
- **Code tabs** — multiple language examples in a single block:
22
-
23
- ```markdown
24
- {% tabs %}
25
- {% tab title="TypeScript" %}
26
- ```typescript
27
- const client = new GitBookAPI({ authToken: token });
28
- ```
29
- {% endtab %}
30
- {% tab title="cURL" %}
31
- ```bash
32
- curl -H "Authorization: Bearer $TOKEN" https://api.gitbook.com/v1/user
33
- ```
34
- {% endtab %}
35
- {% endtabs %}
36
- ```
37
-
38
- ### Hints (Callouts)
39
-
40
- ```markdown
41
- {% hint style="info" %}
42
- This is an informational callout.
43
- {% endhint %}
44
-
45
- {% hint style="warning" %}
46
- Proceed with caution.
47
- {% endhint %}
48
-
49
- {% hint style="success" %}
50
- Operation completed successfully.
51
- {% endhint %}
52
-
53
- {% hint style="danger" %}
54
- This action is irreversible.
55
- {% endhint %}
56
- ```
57
-
58
- Available styles: `info`, `warning`, `success`, `danger`.
59
-
60
- ### Tabs
61
-
62
- ```markdown
63
- {% tabs %}
64
- {% tab title="macOS" %}
65
- Installation instructions for macOS.
66
- {% endtab %}
67
- {% tab title="Linux" %}
68
- Installation instructions for Linux.
69
- {% endtab %}
70
- {% tab title="Windows" %}
71
- Installation instructions for Windows.
72
- {% endtab %}
73
- {% endtabs %}
74
- ```
75
-
76
- ### Expandable Sections
77
-
78
- ```markdown
79
- <details>
80
- <summary>Click to expand</summary>
81
-
82
- Hidden content goes here. Supports full Markdown.
83
-
84
- </details>
85
- ```
86
-
87
- ### Cards
88
-
89
- Link cards with optional images, rendered as visual previews:
90
-
91
- ```markdown
92
- {% content-ref url="getting-started.md" %}
93
- [getting-started.md](getting-started.md)
94
- {% endcontent-ref %}
95
- ```
96
-
97
- ### Embedded URLs
98
-
99
- Auto-expanding embeds for supported services:
100
-
101
- ```markdown
102
- {% embed url="https://www.youtube.com/watch?v=VIDEO_ID" %}
103
- YouTube video title
104
- {% endembed %}
105
-
106
- {% embed url="https://www.figma.com/file/FILE_ID" %}
107
- Figma design
108
- {% endembed %}
109
- ```
110
-
111
- Supported embed providers include YouTube, Vimeo, Figma, CodePen, Loom, Google Drive, and others.
112
-
113
- ### Math (LaTeX)
114
-
115
- Inline math: `$$E = mc^2$$`
116
-
117
- Block math:
118
-
119
- ```markdown
120
- $$
121
- \int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
122
- $$
123
- ```
124
-
125
- ### Files
126
-
127
- Attach downloadable files:
128
-
129
- ```markdown
130
- {% file src=".gitbook/assets/report.pdf" %}
131
- Download the full report
132
- {% endfile %}
133
- ```
134
-
135
- ### Drawings
136
-
137
- Created in the GitBook editor's built-in drawing tool. These are stored as SVG assets and referenced in the page content. Not editable via Git Sync — use the editor.
138
-
139
- ### Tables
140
-
141
- Standard Markdown tables:
142
-
143
- ```markdown
144
- | Header 1 | Header 2 | Header 3 |
145
- |----------|----------|----------|
146
- | Cell 1 | Cell 2 | Cell 3 |
147
- | Cell 4 | Cell 5 | Cell 6 |
148
- ```
149
-
150
- ### Images
151
-
152
- ```markdown
153
- ![Alt text](path/to/image.png)
154
-
155
- <!-- With caption -->
156
- <figure><img src="path/to/image.png" alt="Description"><figcaption>Caption text</figcaption></figure>
157
- ```
158
-
159
- Image paths in Git Sync should be relative to the page file or use `.gitbook/assets/` for shared assets.
160
-
161
- ## OpenAPI Integration
162
-
163
- GitBook renders OpenAPI (Swagger) specifications as interactive API reference pages.
164
-
165
- ### Methods
166
-
167
- **1. URL reference in the editor:**
168
- Paste an OpenAPI spec URL in the editor. GitBook fetches and renders it.
169
-
170
- **2. File in Git Sync:**
171
- Place `.yaml` or `.json` OpenAPI files in your repository. Reference them in pages:
172
-
173
- ```markdown
174
- {% swagger src="./openapi.yaml" path="/users" method="get" %}
175
- [openapi.yaml](openapi.yaml)
176
- {% endswagger %}
177
- ```
178
-
179
- **3. Inline specification:**
180
- Paste the full spec inline (not recommended for large specs).
181
-
182
- ### Rendered Output
183
-
184
- GitBook generates:
185
- - Endpoint listings with method badges (GET, POST, etc.)
186
- - Request/response schemas with type information
187
- - Try-it-out functionality for testing endpoints
188
- - Authentication configuration display
189
- - Parameter descriptions and examples
190
-
191
- ### Supported Versions
192
-
193
- - OpenAPI 3.0.x
194
- - OpenAPI 3.1.x
195
- - Swagger 2.0 (converted internally)
196
-
197
- ## Markdown Extensions Summary
198
-
199
- | Syntax | Renders As |
200
- |--------|------------|
201
- | `{% hint style="..." %}` | Callout box |
202
- | `{% tabs %}` / `{% tab %}` | Tabbed content |
203
- | `{% embed url="..." %}` | Rich embed |
204
- | `{% swagger src="..." %}` | API reference |
205
- | `{% content-ref url="..." %}` | Link card |
206
- | `{% file src="..." %}` | File download |
207
- | `$$...$$` | Math equation |
208
- | `<details>` / `<summary>` | Expandable section |
209
-
210
- ## Assets Directory
211
-
212
- Git-synced repos store uploaded assets in `.gitbook/assets/`:
213
-
214
- ```
215
- docs/
216
- ├── .gitbook/
217
- │ └── assets/
218
- │ ├── logo.png
219
- │ └── diagram.svg
220
- ├── README.md
221
- └── SUMMARY.md
222
- ```
223
-
224
- Reference assets with relative paths from the page: `../.gitbook/assets/logo.png` or absolute from root: `.gitbook/assets/logo.png`.
225
-
226
- ## Resources
227
-
228
- - **Content Editor**: https://docs.gitbook.com/content-editor
229
- - **OpenAPI**: https://docs.gitbook.com/integrations/openapi
230
- - **Markdown**: https://docs.gitbook.com/content-editor/editing-content/markdown
@@ -1,202 +0,0 @@
1
- # Docs Sites Reference
2
-
3
- Publishing, Site Sections, custom domains, content variants, and SEO for GitBook Docs Sites.
4
-
5
- ## Overview
6
-
7
- A **Docs Site** is the published, visitor-facing representation of your documentation. Sites can combine multiple spaces via Site Sections, apply custom branding, use custom domains, and serve versioned content through variants.
8
-
9
- ## Creating a Docs Site
10
-
11
- ### Via UI
12
-
13
- 1. Navigate to your organization dashboard
14
- 2. Click **New site**
15
- 3. Choose a name and link your first space
16
- 4. Configure audience (public, authenticated, or private)
17
-
18
- ### Via API
19
-
20
- ```typescript
21
- const site = await client.orgs.createSite(orgId, {
22
- title: 'Developer Documentation',
23
- });
24
- ```
25
-
26
- ## Site Sections
27
-
28
- Site Sections combine multiple spaces into a single site with tab-based or dropdown navigation.
29
-
30
- ### Adding Sections
31
-
32
- ```typescript
33
- // Add individual sections
34
- await client.sites.addSiteSection(siteId, {
35
- spaceId: apiDocsSpaceId,
36
- title: 'API Reference',
37
- });
38
-
39
- await client.sites.addSiteSection(siteId, {
40
- spaceId: guidesSpaceId,
41
- title: 'Guides',
42
- });
43
- ```
44
-
45
- ### Section Groups
46
-
47
- Group sections under a dropdown heading:
48
-
49
- ```typescript
50
- await client.sites.addSiteSectionGroup(siteId, {
51
- title: 'Products',
52
- sections: [productASection, productBSection],
53
- });
54
- ```
55
-
56
- ### Nested Groups
57
-
58
- Since September 2025, GitBook supports **nested section groups** — groups within groups. This enables hierarchical navigation like:
59
-
60
- ```
61
- Products (dropdown)
62
- ├── Platform
63
- │ ├── API Reference
64
- │ └── SDK Guide
65
- └── Tools
66
- ├── CLI Reference
67
- └── Plugin Guide
68
- ```
69
-
70
- ### Section Settings
71
-
72
- Each section can have:
73
- - **Title**: Display name in the navigation tab
74
- - **Icon**: Optional icon next to the title
75
- - **Description**: Shown in dropdown menus for grouped sections
76
-
77
- ## Custom Domains
78
-
79
- ### Setup
80
-
81
- 1. Add a CNAME DNS record: `docs.example.com → hosting.gitbook.io`
82
- 2. Configure in site settings or via API:
83
-
84
- ```typescript
85
- await client.sites.updateSiteCustomization(siteId, {
86
- hostname: 'docs.example.com',
87
- });
88
- ```
89
-
90
- 3. GitBook provisions an SSL certificate automatically
91
-
92
- ### Multiple Domains
93
-
94
- Each site supports one custom domain. For multiple domains, create separate sites or use DNS-level redirects.
95
-
96
- ## Branding & Customization
97
-
98
- ```typescript
99
- await client.sites.updateSiteCustomization(siteId, {
100
- // Colors and fonts
101
- styling: {
102
- primaryColor: '#0066FF',
103
- font: 'Inter', // Inter, Roboto, Poppins, etc.
104
- },
105
-
106
- // Theme
107
- themes: {
108
- default: 'light', // light | dark
109
- toggleable: true, // Allow visitors to toggle
110
- },
111
-
112
- // Logos
113
- favicon: 'https://example.com/favicon.ico',
114
- logo: {
115
- light: 'https://example.com/logo-light.png',
116
- dark: 'https://example.com/logo-dark.png',
117
- },
118
- });
119
- ```
120
-
121
- ### Customizable Elements
122
-
123
- | Element | Options |
124
- |---------|---------|
125
- | Primary color | Any hex color |
126
- | Font family | Inter, Roboto, Poppins, Source Sans Pro, and others |
127
- | Theme | Light, dark, or toggleable |
128
- | Logo | Separate light/dark variants |
129
- | Favicon | Custom favicon URL |
130
- | Header links | Custom navigation links |
131
- | Footer | Custom footer content |
132
-
133
- ## Content Variants
134
-
135
- Variants maintain multiple versions of content within a single space.
136
-
137
- ### Use Cases
138
-
139
- - API version documentation (v1, v2, v3)
140
- - Product editions (Community, Enterprise)
141
- - Language variants (en, fr, de)
142
-
143
- ### Creating Variants
144
-
145
- ```typescript
146
- // Create version variants
147
- await client.spaces.createVariant(spaceId, { title: 'v1.0', slug: 'v1' });
148
- await client.spaces.createVariant(spaceId, { title: 'v2.0', slug: 'v2' });
149
-
150
- // Set the default variant visitors see
151
- await client.spaces.setDefaultVariant(spaceId, v2VariantId);
152
- ```
153
-
154
- ### Variant URLs
155
-
156
- Variants are accessible via slug in the URL:
157
-
158
- ```
159
- https://docs.example.com/v1/getting-started
160
- https://docs.example.com/v2/getting-started
161
- ```
162
-
163
- The default variant is served at the root URL without a slug prefix.
164
-
165
- ### Variant vs. Site Sections
166
-
167
- | Feature | Variants | Site Sections |
168
- |---------|----------|---------------|
169
- | Content | Same space, different versions | Different spaces |
170
- | Navigation | Version dropdown | Top-level tabs |
171
- | Use case | Versioned docs | Multi-product docs |
172
- | URL pattern | `/v2/page` | `/section/page` |
173
-
174
- ## SEO
175
-
176
- GitBook generates SEO-friendly output automatically:
177
-
178
- - **Sitemaps**: Auto-generated at `/sitemap.xml`
179
- - **Open Graph**: Meta tags for social sharing
180
- - **Structured data**: JSON-LD for search engines
181
- - **Clean URLs**: Slug-based paths without file extensions
182
- - **Meta descriptions**: Set per page in the editor
183
- - **Canonical URLs**: Automatically set for custom domains
184
-
185
- ### Custom Meta
186
-
187
- Set per-page descriptions in the GitBook editor via the page settings panel. These appear in search engine results.
188
-
189
- ## Audience Settings
190
-
191
- | Setting | Description |
192
- |---------|-------------|
193
- | Public | Anyone can view |
194
- | Authenticated | Requires login via visitor auth provider |
195
- | Private | Only organization members |
196
-
197
- ## Resources
198
-
199
- - **Docs Sites**: https://gitbook.com/docs/publishing-documentation
200
- - **Site Sections**: https://gitbook.com/docs/publishing-documentation/site-structure/site-sections
201
- - **Custom Domains**: https://docs.gitbook.com/publishing-documentation/custom-domain
202
- - **Customization**: https://docs.gitbook.com/publishing-documentation/customization
@@ -1,175 +0,0 @@
1
- # Git Sync Reference
2
-
3
- Bidirectional synchronization between a Git repository (GitHub or GitLab) and a GitBook space.
4
-
5
- ## Overview
6
-
7
- Git Sync connects a GitBook space to a branch in your repository. Edits in either location are synced to the other. The GitHub App integration handles webhooks and authentication.
8
-
9
- ## Setup
10
-
11
- ### GitHub Integration
12
-
13
- 1. Open your space in GitBook
14
- 2. Navigate to **Integrations > Git Sync**
15
- 3. Click **Connect with GitHub** — installs the GitBook GitHub App
16
- 4. Select the repository and branch
17
- 5. Choose sync direction: **GitHub to GitBook**, **GitBook to GitHub**, or **Bidirectional**
18
-
19
- ### GitLab Integration
20
-
21
- 1. Navigate to **Integrations > Git Sync**
22
- 2. Click **Connect with GitLab**
23
- 3. Provide a GitLab personal access token with `api` scope
24
- 4. Select the project and branch
25
-
26
- ## .gitbook.yaml
27
-
28
- Optional configuration file at the repository root (or at the root specified by the `root` field).
29
-
30
- ```yaml
31
- # Root directory for documentation (relative to repo root)
32
- root: ./docs/
33
-
34
- # Structure files
35
- structure:
36
- readme: README.md # Main page file name (default: README.md)
37
- summary: SUMMARY.md # Table of contents file (default: SUMMARY.md)
38
-
39
- # Redirects for moved/renamed pages
40
- redirects:
41
- previous/page: current/page.md
42
- old-guide: guides/new-guide.md
43
- ```
44
-
45
- ### Fields
46
-
47
- | Field | Default | Description |
48
- |-------|---------|-------------|
49
- | `root` | `./` | Root directory for docs content |
50
- | `structure.readme` | `README.md` | Filename for the space's main page |
51
- | `structure.summary` | `SUMMARY.md` | Filename for the table of contents |
52
- | `redirects` | — | Map of old paths to new paths |
53
-
54
- ## SUMMARY.md
55
-
56
- Defines the page hierarchy and navigation structure. GitBook reads this file to determine the sidebar tree.
57
-
58
- ### Format
59
-
60
- ```markdown
61
- # Summary
62
-
63
- ## Section Title
64
-
65
- * [Page Title](path/to/page.md)
66
- * [Another Page](path/to/another.md)
67
- * [Nested Page](path/to/nested.md)
68
- * [Deep Nested](path/to/deep.md)
69
-
70
- ## Another Section
71
-
72
- * [Page](section2/page.md)
73
- ```
74
-
75
- ### Rules
76
-
77
- - Top-level `## Headings` create navigation groups
78
- - `* [Title](path.md)` creates a page link
79
- - Indentation (2 spaces) creates nesting
80
- - Maximum 3 levels of nesting recommended
81
- - Links must be relative paths from the `root` directory
82
- - Each linked file must exist or GitBook shows a warning
83
- - `README.md` in a directory serves as the group's landing page
84
-
85
- ### Example — Multi-Section Docs
86
-
87
- ```markdown
88
- # Summary
89
-
90
- ## Getting Started
91
- * [Introduction](README.md)
92
- * [Installation](getting-started/installation.md)
93
- * [Quick Start](getting-started/quickstart.md)
94
- * [Configuration](getting-started/config.md)
95
-
96
- ## User Guide
97
- * [Overview](guide/README.md)
98
- * [Basic Usage](guide/basics.md)
99
- * [Advanced Topics](guide/advanced/README.md)
100
- * [Plugins](guide/advanced/plugins.md)
101
- * [Theming](guide/advanced/theming.md)
102
- * [Hooks](guide/advanced/hooks.md)
103
-
104
- ## API Reference
105
- * [REST API](api/rest.md)
106
- * [TypeScript SDK](api/sdk.md)
107
- * [Webhooks](api/webhooks.md)
108
-
109
- ## Resources
110
- * [FAQ](resources/faq.md)
111
- * [Troubleshooting](resources/troubleshooting.md)
112
- * [Changelog](CHANGELOG.md)
113
- ```
114
-
115
- ## Mono-Repo Support
116
-
117
- For repositories containing more than just documentation:
118
-
119
- ```yaml
120
- # .gitbook.yaml at repo root
121
- root: ./packages/docs/
122
-
123
- structure:
124
- readme: README.md
125
- summary: SUMMARY.md
126
- ```
127
-
128
- Only files under `root` are synced. The rest of the repository is ignored.
129
-
130
- ## Sync Directions
131
-
132
- | Direction | Behavior |
133
- |-----------|----------|
134
- | GitHub → GitBook | Repo is source of truth. Push triggers import. GitBook editor is read-only. |
135
- | GitBook → GitHub | GitBook is source of truth. Edits create commits on the branch. |
136
- | Bidirectional | Both are editable. Most recent change wins. Conflicts shown in UI. |
137
-
138
- ### Conflict Resolution
139
-
140
- When bidirectional sync encounters conflicts:
141
- 1. GitBook displays a conflict notification
142
- 2. Choose to keep the GitBook version or the Git version
143
- 3. The chosen version is synced to both locations
144
-
145
- ## Branch Strategy
146
-
147
- - **Production branch** (`main`): Sync to the primary space for live docs
148
- - **Feature branches**: Create a separate space or use Change Requests
149
- - **Version branches** (`v1`, `v2`): Sync each to a content variant
150
-
151
- ## Supported File Types
152
-
153
- | Extension | Treatment |
154
- |-----------|-----------|
155
- | `.md` | Parsed as content pages |
156
- | `.yaml` / `.json` | OpenAPI specs rendered as API references |
157
- | Images (`.png`, `.jpg`, `.svg`, `.gif`) | Stored as assets |
158
- | Other files | Ignored by GitBook |
159
-
160
- ## Troubleshooting
161
-
162
- | Issue | Cause | Fix |
163
- |-------|-------|-----|
164
- | Sync not triggering | GitHub App webhook failed | Re-install the GitHub App |
165
- | Pages missing | Not listed in SUMMARY.md | Add entries to SUMMARY.md |
166
- | Wrong page order | SUMMARY.md ordering | Reorder entries in SUMMARY.md |
167
- | Images broken | Path is absolute | Use relative paths from the page file |
168
- | .gitbook.yaml ignored | File not at repo root | Move to repository root |
169
- | Conflicts on every sync | Bidirectional with frequent edits | Choose a single direction |
170
-
171
- ## Resources
172
-
173
- - **Git Sync Docs**: https://docs.gitbook.com/integrations/git-sync
174
- - **GitHub App**: https://github.com/apps/gitbook-com
175
- - **.gitbook.yaml Reference**: https://docs.gitbook.com/integrations/git-sync/content-configuration