feat(clp-docs): Add clp-text vs. clp-json to show capabilities and limitations of each flavor; move flavor selection in quick-start to new page
#1291
Conversation
WalkthroughDocumentation-only update: added a new "text-v-json" comparison page, refactored the quick-start index to a flavour-agnostic flow, updated a cross-reference in the clp-json quick-start, and added the new page to the main user-docs toctree. No code or public API changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
docs/src/user-docs/index.md(1 hunks)docs/src/user-docs/quick-start/clp-json.md(1 hunks)docs/src/user-docs/quick-start/index.md(1 hunks)docs/src/user-docs/quick-start/text-v-json.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-01-16T16:58:43.190Z
Learnt from: haiqi96
PR: y-scope/clp#651
File: components/clp-package-utils/clp_package_utils/scripts/compress.py:0-0
Timestamp: 2025-01-16T16:58:43.190Z
Learning: In the clp-package compression flow, path validation and error handling is performed at the scheduler level rather than in the compress.py script to maintain simplicity and avoid code duplication.
Applied to files:
docs/src/user-docs/quick-start/clp-json.md
📚 Learning: 2025-06-18T20:39:05.899Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:73-109
Timestamp: 2025-06-18T20:39:05.899Z
Learning: The CLP project team prefers to use video content to demonstrate detailed procedural steps (like tarball extraction) rather than including every step in the written documentation, keeping the docs focused on conceptual guidance.
Applied to files:
docs/src/user-docs/quick-start/index.md
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-docs/quick-start/text-v-json.md
13-13: Link fragments should be valid
(MD051, link-fragments)
20-20: Inline HTML
Element: span
(MD033, no-inline-html)
20-20: Inline HTML
Element: strong
(MD033, no-inline-html)
20-20: Inline HTML
Element: span
(MD033, no-inline-html)
20-20: Inline HTML
Element: strong
(MD033, no-inline-html)
21-21: Inline HTML
Element: span
(MD033, no-inline-html)
21-21: Inline HTML
Element: strong
(MD033, no-inline-html)
21-21: Inline HTML
Element: sup
(MD033, no-inline-html)
21-21: Inline HTML
Element: span
(MD033, no-inline-html)
21-21: Inline HTML
Element: strong
(MD033, no-inline-html)
22-22: Inline HTML
Element: span
(MD033, no-inline-html)
22-22: Inline HTML
Element: strong
(MD033, no-inline-html)
22-22: Inline HTML
Element: span
(MD033, no-inline-html)
22-22: Inline HTML
Element: strong
(MD033, no-inline-html)
23-23: Inline HTML
Element: span
(MD033, no-inline-html)
23-23: Inline HTML
Element: strong
(MD033, no-inline-html)
23-23: Inline HTML
Element: span
(MD033, no-inline-html)
23-23: Inline HTML
Element: strong
(MD033, no-inline-html)
24-24: Inline HTML
Element: span
(MD033, no-inline-html)
24-24: Inline HTML
Element: strong
(MD033, no-inline-html)
24-24: Inline HTML
Element: span
(MD033, no-inline-html)
24-24: Inline HTML
Element: strong
(MD033, no-inline-html)
25-25: Inline HTML
Element: span
(MD033, no-inline-html)
25-25: Inline HTML
Element: strong
(MD033, no-inline-html)
25-25: Inline HTML
Element: span
(MD033, no-inline-html)
25-25: Inline HTML
Element: strong
(MD033, no-inline-html)
26-26: Inline HTML
Element: span
(MD033, no-inline-html)
26-26: Inline HTML
Element: strong
(MD033, no-inline-html)
26-26: Inline HTML
Element: span
(MD033, no-inline-html)
26-26: Inline HTML
Element: strong
(MD033, no-inline-html)
27-27: Inline HTML
Element: span
(MD033, no-inline-html)
27-27: Inline HTML
Element: strong
(MD033, no-inline-html)
27-27: Inline HTML
Element: sup
(MD033, no-inline-html)
27-27: Inline HTML
Element: span
(MD033, no-inline-html)
27-27: Inline HTML
Element: strong
(MD033, no-inline-html)
27-27: Inline HTML
Element: sup
(MD033, no-inline-html)
28-28: Inline HTML
Element: span
(MD033, no-inline-html)
28-28: Inline HTML
Element: strong
(MD033, no-inline-html)
28-28: Inline HTML
Element: sup
(MD033, no-inline-html)
28-28: Inline HTML
Element: span
(MD033, no-inline-html)
28-28: Inline HTML
Element: strong
(MD033, no-inline-html)
28-28: Inline HTML
Element: sup
(MD033, no-inline-html)
29-29: Inline HTML
Element: span
(MD033, no-inline-html)
29-29: Inline HTML
Element: strong
(MD033, no-inline-html)
29-29: Inline HTML
Element: span
(MD033, no-inline-html)
29-29: Inline HTML
Element: strong
(MD033, no-inline-html)
30-30: Inline HTML
Element: span
(MD033, no-inline-html)
30-30: Inline HTML
Element: strong
(MD033, no-inline-html)
30-30: Inline HTML
Element: span
(MD033, no-inline-html)
30-30: Inline HTML
Element: strong
(MD033, no-inline-html)
31-31: Inline HTML
Element: span
(MD033, no-inline-html)
31-31: Inline HTML
Element: strong
(MD033, no-inline-html)
31-31: Inline HTML
Element: span
(MD033, no-inline-html)
31-31: Inline HTML
Element: strong
(MD033, no-inline-html)
32-32: Inline HTML
Element: span
(MD033, no-inline-html)
32-32: Inline HTML
Element: strong
(MD033, no-inline-html)
32-32: Inline HTML
Element: span
(MD033, no-inline-html)
32-32: Inline HTML
Element: strong
(MD033, no-inline-html)
33-33: Inline HTML
Element: span
(MD033, no-inline-html)
33-33: Inline HTML
Element: strong
(MD033, no-inline-html)
33-33: Inline HTML
Element: span
(MD033, no-inline-html)
33-33: Inline HTML
Element: strong
(MD033, no-inline-html)
34-34: Inline HTML
Element: span
(MD033, no-inline-html)
34-34: Inline HTML
Element: strong
(MD033, no-inline-html)
34-34: Inline HTML
Element: span
(MD033, no-inline-html)
34-34: Inline HTML
Element: strong
(MD033, no-inline-html)
35-35: Inline HTML
Element: span
(MD033, no-inline-html)
35-35: Inline HTML
Element: strong
(MD033, no-inline-html)
35-35: Inline HTML
Element: span
(MD033, no-inline-html)
35-35: Inline HTML
Element: strong
(MD033, no-inline-html)
39-39: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: lint-check (macos-15)
- GitHub Check: lint-check (ubuntu-24.04)
🔇 Additional comments (4)
docs/src/user-docs/quick-start/clp-json.md (1)
48-48: LGTM: updated cross-reference points to a valid anchor.The link to ./text-v-json.md#clp-json matches the new page and section name.
docs/src/user-docs/quick-start/index.md (2)
52-54: LGTM: clearer flavour bullets with inline code.
60-65: LGTM: succinct download flow and helpful link to the comparison page.No action needed.
docs/src/user-docs/quick-start/text-v-json.md (1)
52-78: Nice: clear clp-json section and example; anchors align with cross-references.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/src/user-docs/quick-start/text-v-json.md (1)
13-13: Resolve MD051 by using MyST refs (or disable rule locally).Replace the fragment link with a MyST reference; this both satisfies markdownlint and auto-numbers.
-[Table 1](#table-1) compares the different capabilities and limitations of each of the two flavors. +See {numref}`table-1` for a comparison of the capabilities and limitations of each flavour.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-docs/index.md(1 hunks)docs/src/user-docs/quick-start/text-v-json.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-08T21:41:32.032Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1291
File: docs/src/user-docs/quick-start/text-v-json.md:84-88
Timestamp: 2025-09-08T21:41:32.032Z
Learning: In the y-scope/clp project documentation, maintain informal contractions like "can't" and "don't" rather than formal alternatives like "cannot" and "do not" - the maintainer prefers a conversational tone.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
📚 Learning: 2025-08-15T21:48:40.228Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1181
File: docs/src/user-guide/guides-retention.md:68-73
Timestamp: 2025-08-15T21:48:40.228Z
Learning: In documentation for the CLP project, when suggesting formatting improvements for variables in explanatory text, the user quinntaylormitchell prefers to maintain existing sentence structures (like keeping "that" in "i.e., that the difference...") while applying monospace formatting to technical terms and variables for consistency.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-docs/quick-start/text-v-json.md
13-13: Link fragments should be valid
(MD051, link-fragments)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-check (ubuntu-24.04)
🔇 Additional comments (2)
docs/src/user-docs/quick-start/text-v-json.md (1)
85-88: Contraction style matches project preference.Keeping “don't/can't” aligns with the team’s preferred conversational tone.
docs/src/user-docs/index.md (1)
53-56: Good placement of the comparison page in the Quick start toctree.The ordering promotes discovery before per-flavour guides.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
docs/src/user-docs/quick-start/text-v-json.md (3)
13-13: Fix MD051: use MyST reference instead of a fragment link.Replace the fragment link with a MyST label ref to avoid markdownlint’s MD051.
-[Table 1](#table-1) compares the different capabilities and limitations of each of the two flavors. +See {ref}`Table 1 <table-1>` for a comparison of the capabilities and limitations of each flavour.
16-21: Remove inline HTML/CSS to satisfy MD033.Drop the <style> block; use plain Unicode symbols in the table instead.
-(style> -.g,.r,.o{font-weight:700;font-style:normal} -.g::after{content:"✓";color:green} -.r::after{content:"✗";color:red} -.o::after{content:"〇";color:orange} -</style> +<!-- Removed inline CSS; table below uses ✓, ✗, and 〇 without styling -->
44-55: Keep notes near the table; minor copy/punctuation and HTTPS consistency.
- Keep the notes block directly below the table (author preference).
- Tighten copy and ensure HTTPS.
-**Table 1**: The capabilities and limitations of CLP's two flavors. +**Table 1**: High-level comparison of CLP flavours and capabilities. + -1) `clp-text` is able to compress and search JSON logs as if they were unstructured text, but - `clp-text` cannot query individual fields. -2) Timestamp parsing is limited to specific supported formats: see - [clp-text timestamp formats][ts-text] and [clp-json timestamp formats][ts-json] for more details. -3) Timestamps are parsed automatically as long as the timestamp key for the logs is provided at - compression time using the `--timestamp-key` flag. -4) We hope to introduce support for the preservation of time zone information in a future update - (issue is up [here](https://github.com/y-scope/clp/issues/1290)) +1. `clp-text` can compress/search JSON logs as unstructured text, but cannot query individual fields. +2. Timestamp parsing is limited to specific supported formats: see + [clp-text timestamp formats][ts-text] and [clp-json timestamp formats][ts-json]. +3. Timestamps are parsed automatically when the timestamp key is provided at compression time via `--timestamp-key`. +4. Preservation of time zone information is planned (see [issue #1290](https://github.com/y-scope/clp/issues/1290)).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-docs/quick-start/index.md(1 hunks)docs/src/user-docs/quick-start/text-v-json.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-08T21:41:32.059Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1291
File: docs/src/user-docs/quick-start/text-v-json.md:84-88
Timestamp: 2025-09-08T21:41:32.059Z
Learning: In the y-scope/clp project documentation, maintain informal contractions like "can't" and "don't" rather than formal alternatives like "cannot" and "do not" - the maintainer prefers a conversational tone.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
📚 Learning: 2025-08-15T21:48:40.228Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1181
File: docs/src/user-guide/guides-retention.md:68-73
Timestamp: 2025-08-15T21:48:40.228Z
Learning: In documentation for the CLP project, when suggesting formatting improvements for variables in explanatory text, the user quinntaylormitchell prefers to maintain existing sentence structures (like keeping "that" in "i.e., that the difference...") while applying monospace formatting to technical terms and variables for consistency.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
📚 Learning: 2025-06-18T20:39:05.899Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:73-109
Timestamp: 2025-06-18T20:39:05.899Z
Learning: The CLP project team prefers to use video content to demonstrate detailed procedural steps (like tarball extraction) rather than including every step in the written documentation, keeping the docs focused on conceptual guidance.
Applied to files:
docs/src/user-docs/quick-start/index.md
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-docs/quick-start/text-v-json.md
13-13: Link fragments should be valid
(MD051, link-fragments)
16-16: Inline HTML
Element: style
(MD033, no-inline-html)
27-27: Inline HTML
Element: b
(MD033, no-inline-html)
27-27: Inline HTML
Element: b
(MD033, no-inline-html)
28-28: Inline HTML
Element: b
(MD033, no-inline-html)
28-28: Inline HTML
Element: sup
(MD033, no-inline-html)
28-28: Inline HTML
Element: b
(MD033, no-inline-html)
29-29: Inline HTML
Element: b
(MD033, no-inline-html)
29-29: Inline HTML
Element: b
(MD033, no-inline-html)
30-30: Inline HTML
Element: b
(MD033, no-inline-html)
30-30: Inline HTML
Element: b
(MD033, no-inline-html)
31-31: Inline HTML
Element: b
(MD033, no-inline-html)
31-31: Inline HTML
Element: b
(MD033, no-inline-html)
32-32: Inline HTML
Element: b
(MD033, no-inline-html)
32-32: Inline HTML
Element: b
(MD033, no-inline-html)
33-33: Inline HTML
Element: b
(MD033, no-inline-html)
33-33: Inline HTML
Element: b
(MD033, no-inline-html)
34-34: Inline HTML
Element: b
(MD033, no-inline-html)
34-34: Inline HTML
Element: sup
(MD033, no-inline-html)
34-34: Inline HTML
Element: b
(MD033, no-inline-html)
34-34: Inline HTML
Element: sup
(MD033, no-inline-html)
35-35: Inline HTML
Element: b
(MD033, no-inline-html)
35-35: Inline HTML
Element: sup
(MD033, no-inline-html)
35-35: Inline HTML
Element: b
(MD033, no-inline-html)
35-35: Inline HTML
Element: sup
(MD033, no-inline-html)
36-36: Inline HTML
Element: b
(MD033, no-inline-html)
36-36: Inline HTML
Element: b
(MD033, no-inline-html)
37-37: Inline HTML
Element: b
(MD033, no-inline-html)
37-37: Inline HTML
Element: b
(MD033, no-inline-html)
38-38: Inline HTML
Element: b
(MD033, no-inline-html)
38-38: Inline HTML
Element: b
(MD033, no-inline-html)
39-39: Inline HTML
Element: b
(MD033, no-inline-html)
39-39: Inline HTML
Element: b
(MD033, no-inline-html)
40-40: Inline HTML
Element: b
(MD033, no-inline-html)
40-40: Inline HTML
Element: b
(MD033, no-inline-html)
41-41: Inline HTML
Element: b
(MD033, no-inline-html)
41-41: Inline HTML
Element: b
(MD033, no-inline-html)
42-42: Inline HTML
Element: b
(MD033, no-inline-html)
42-42: Inline HTML
Element: b
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: lint-check (ubuntu-24.04)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (4)
docs/src/user-docs/quick-start/text-v-json.md (2)
89-92: Contractions are OK here (maintainer preference).Keeping “don't” and “can't” matches the documented style preference for this project.
112-116: LGTM: secure links and MD013 waivers placed locally.HTTPS links look correct and MD013 is locally suppressed only where needed.
docs/src/user-docs/quick-start/index.md (2)
52-58: Clear flavour guidance; shared-binaries note retained.This succinctly sets user expectations and preserves the config nuance.
60-65: Good navigation flow; add comparison link for undecided users.The Releases-first + quick-start anchor is clear, and the comparison link helps decision-making.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/src/user-docs/quick-start/text-v-json.md (1)
1-116: Fix markdownlint violations in text-v-json.mdMarkdownlint still reports 55 errors in docs/src/user-docs/quick-start/text-v-json.md, including:
- MD033: remove all inline HTML elements (
<style>,<b>,<sup>)- MD051: ensure link fragments (e.g.
[Table 1](#table-1)) match valid heading IDs- MD013: wrap lines to ≤ 80 characters
Resolve these so the file passes
markdownlint-cli2.
♻️ Duplicate comments (2)
docs/src/user-docs/quick-start/text-v-json.md (2)
13-13: Fix MD051: use MyST cross‑ref instead of a fragment.Replace the fragment link with a MyST ref to the label to satisfy markdownlint.
-[Table 1](#table-1) compares the different capabilities and limitations of each of the two flavors. +{ref}`table-1` compares the different capabilities and limitations of each of the two flavors.
43-46: Add a blank line before the numbered notes (MD032).Insert one empty line between the caption and the list.
**Table 1**: The capabilities and limitations of CLP's two flavors. + 1) `clp-text` is able to compress and search JSON logs as if they were unstructured text, but
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/quick-start/text-v-json.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-08T21:41:32.059Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1291
File: docs/src/user-docs/quick-start/text-v-json.md:84-88
Timestamp: 2025-09-08T21:41:32.059Z
Learning: In the y-scope/clp project documentation, maintain informal contractions like "can't" and "don't" rather than formal alternatives like "cannot" and "do not" - the maintainer prefers a conversational tone.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
📚 Learning: 2025-08-15T21:48:40.228Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#1181
File: docs/src/user-guide/guides-retention.md:68-73
Timestamp: 2025-08-15T21:48:40.228Z
Learning: In documentation for the CLP project, when suggesting formatting improvements for variables in explanatory text, the user quinntaylormitchell prefers to maintain existing sentence structures (like keeping "that" in "i.e., that the difference...") while applying monospace formatting to technical terms and variables for consistency.
Applied to files:
docs/src/user-docs/quick-start/text-v-json.md
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-docs/quick-start/text-v-json.md
13-13: Link fragments should be valid
(MD051, link-fragments)
17-17: Inline HTML
Element: style
(MD033, no-inline-html)
26-26: Inline HTML
Element: b
(MD033, no-inline-html)
26-26: Inline HTML
Element: b
(MD033, no-inline-html)
27-27: Inline HTML
Element: b
(MD033, no-inline-html)
27-27: Inline HTML
Element: sup
(MD033, no-inline-html)
27-27: Inline HTML
Element: b
(MD033, no-inline-html)
28-28: Inline HTML
Element: b
(MD033, no-inline-html)
28-28: Inline HTML
Element: b
(MD033, no-inline-html)
29-29: Inline HTML
Element: b
(MD033, no-inline-html)
29-29: Inline HTML
Element: b
(MD033, no-inline-html)
30-30: Inline HTML
Element: b
(MD033, no-inline-html)
30-30: Inline HTML
Element: b
(MD033, no-inline-html)
31-31: Inline HTML
Element: b
(MD033, no-inline-html)
31-31: Inline HTML
Element: b
(MD033, no-inline-html)
32-32: Inline HTML
Element: b
(MD033, no-inline-html)
32-32: Inline HTML
Element: b
(MD033, no-inline-html)
33-33: Inline HTML
Element: b
(MD033, no-inline-html)
33-33: Inline HTML
Element: sup
(MD033, no-inline-html)
33-33: Inline HTML
Element: b
(MD033, no-inline-html)
33-33: Inline HTML
Element: sup
(MD033, no-inline-html)
34-34: Inline HTML
Element: b
(MD033, no-inline-html)
34-34: Inline HTML
Element: sup
(MD033, no-inline-html)
34-34: Inline HTML
Element: b
(MD033, no-inline-html)
34-34: Inline HTML
Element: sup
(MD033, no-inline-html)
35-35: Inline HTML
Element: b
(MD033, no-inline-html)
35-35: Inline HTML
Element: b
(MD033, no-inline-html)
36-36: Inline HTML
Element: b
(MD033, no-inline-html)
36-36: Inline HTML
Element: b
(MD033, no-inline-html)
37-37: Inline HTML
Element: b
(MD033, no-inline-html)
37-37: Inline HTML
Element: b
(MD033, no-inline-html)
38-38: Inline HTML
Element: b
(MD033, no-inline-html)
38-38: Inline HTML
Element: b
(MD033, no-inline-html)
39-39: Inline HTML
Element: b
(MD033, no-inline-html)
39-39: Inline HTML
Element: b
(MD033, no-inline-html)
40-40: Inline HTML
Element: b
(MD033, no-inline-html)
40-40: Inline HTML
Element: b
(MD033, no-inline-html)
41-41: Inline HTML
Element: b
(MD033, no-inline-html)
41-41: Inline HTML
Element: b
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: lint-check (ubuntu-24.04)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (2)
docs/src/user-docs/quick-start/text-v-json.md (2)
88-91: Tone is consistent with project preference.Keeping “don't/can't” matches the maintainer’s preference for a conversational tone.
111-115: Good: secure links and local MD013 suppressions.HTTPS links and targeted MD013 disables look correct.
Description
This PR adds a page called
text-v-json.mdto the quick-start guide. The page has a new table that compares the capabilities and limitations ofclp-textandclp-json.In addition, the information to help the user decide which CLP flavor is right for their use case(s) is moved from the quick-start overview page to this new page. This is necessary because
Checklist
breaking change.
Validation performed
Built and served the docs; everything renders correctly.
Summary by CodeRabbit