docs: Restructure quick-start guide into separate end-to-end guides for clp-json and clp-text. #968
Conversation
…d into the new quick-start docs
## Walkthrough
The documentation was reorganized to consolidate and restructure the quick-start guides. Legacy quick-start files were removed and replaced with new, flavour-specific guides for `clp-json` and `clp-text`, along with an updated quick-start overview. Navigation and references were updated throughout to reflect this new structure, with additional improvements to guides and object storage documentation.
## Changes
| File(s) | Change Summary |
|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| docs/src/user-guide/quick-start-cluster-setup/index.md<br>docs/src/user-guide/quick-start-cluster-setup/single-node.md<br>docs/src/user-guide/quick-start-compression/index.md<br>docs/src/user-guide/quick-start-compression/json.md<br>docs/src/user-guide/quick-start-compression/text.md<br>docs/src/user-guide/quick-start-overview.md<br>docs/src/user-guide/quick-start-search/cli-search.md<br>docs/src/user-guide/quick-start-search/index.md<br>docs/src/user-guide/quick-start-search/ui-search.md | Removed legacy quick-start and related documentation files, including cluster setup, compression, and search guides. |
| docs/src/user-guide/quick-start/index.md | Added new quick-start overview guide with system requirements, flavour selection, and navigation cards. |
| docs/src/user-guide/quick-start/clp-json.md | Added new quick-start guide for `clp-json`, covering startup, compression, and search instructions. |
| docs/src/user-guide/quick-start/clp-text.md | Added new quick-start guide for `clp-text`, covering startup, compression, and search instructions. |
| docs/src/user-guide/index.md | Updated navigation structure to nest quick-start entries and reference new guides. |
| docs/src/user-guide/guides-multi-node.md | Revised to reference new quick-start guides and reorganized guide links as cards. |
| docs/src/user-guide/guides-overview.md | Added a new grid card linking to the multi-node deployment guide. |
| docs/src/user-guide/guides-using-object-storage/clp-usage.md<br>docs/src/user-guide/guides-using-object-storage/index.md | Updated references and terminology to point to the new `clp-json` quick-start guide and use "flavour" wording. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant Docs
participant CLP System
User->>Docs: Access quick-start guide
Docs->>User: Present overview (requirements, flavours)
User->>Docs: Select clp-json or clp-text guide
Docs->>User: Show flavour-specific instructions
User->>CLP System: Start CLP service (per guide)
User->>CLP System: Compress logs (per guide)
User->>CLP System: Search logs (CLI or UI, per guide)Possibly related PRs
Suggested reviewers
Learnt from: gibber9809 Learnt from: quinntaylormitchell Learnt from: quinntaylormitchell Learnt from: Bill-hbrhbr Learnt from: quinntaylormitchell Learnt from: jackluo923 Learnt from: jackluo923 Learnt from: jackluo923 Learnt from: jackluo923 Learnt from: jackluo923 Learnt from: jackluo923 Learnt from: haiqi96 Learnt from: quinntaylormitchell Learnt from: kirkrodrigues Learnt from: kirkrodrigues Learnt from: AVMatthews Learnt from: jackluo923 Learnt from: gibber9809 Learnt from: junhaoliao Learnt from: gibber9809 Learnt from: AVMatthews Learnt from: gibber9809 Learnt from: AVMatthews Learnt from: AVMatthews Learnt from: haiqi96 Learnt from: LinZhihao-723 |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 20
🔭 Outside diff range comments (1)
docs/src/user-guide/guides/guides-using-object-storage/index.md (1)
138-140: 🧹 Nitpick (assertive)Rename reference ID for clarity
At the bottom,[release-choices]: ../../quick-start/clp-json/main-pagecould be updated to match any new ref-ID (e.g.[clp-json-quick-start]: …).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/src/user-guide/quick-start/clp-json/clp-search-ui.pngis excluded by!**/*.pngdocs/src/user-guide/quick-start/clp-text/clp-search-ui.pngis excluded by!**/*.png
📒 Files selected for processing (23)
docs/src/dev-guide/design-kv-ir-streams/background.md(2 hunks)docs/src/index.md(1 hunks)docs/src/user-guide/core/core-clp-s.md(2 hunks)docs/src/user-guide/core/core-unstructured/clp.md(1 hunks)docs/src/user-guide/guides/guides-multi-node/multi-node.md(1 hunks)docs/src/user-guide/guides/guides-overview.md(1 hunks)docs/src/user-guide/guides/guides-using-object-storage/clp-usage.md(1 hunks)docs/src/user-guide/guides/guides-using-object-storage/index.md(3 hunks)docs/src/user-guide/index.md(2 hunks)docs/src/user-guide/quick-start-cluster-setup/index.md(0 hunks)docs/src/user-guide/quick-start-cluster-setup/single-node.md(0 hunks)docs/src/user-guide/quick-start-compression/index.md(0 hunks)docs/src/user-guide/quick-start-compression/json.md(0 hunks)docs/src/user-guide/quick-start-compression/text.md(0 hunks)docs/src/user-guide/quick-start-overview.md(0 hunks)docs/src/user-guide/quick-start-search/cli-search.md(0 hunks)docs/src/user-guide/quick-start-search/index.md(0 hunks)docs/src/user-guide/quick-start-search/ui-search.md(0 hunks)docs/src/user-guide/quick-start/clp-json/main-page.md(1 hunks)docs/src/user-guide/quick-start/clp-text/main-page.md(1 hunks)docs/src/user-guide/quick-start/index.md(1 hunks)docs/src/user-guide/quick-start/setup/main-page.md(1 hunks)docs/src/user-guide/reference/index.md(1 hunks)
💤 Files with no reviewable changes (9)
- docs/src/user-guide/quick-start-cluster-setup/single-node.md
- docs/src/user-guide/quick-start-compression/text.md
- docs/src/user-guide/quick-start-overview.md
- docs/src/user-guide/quick-start-compression/index.md
- docs/src/user-guide/quick-start-search/index.md
- docs/src/user-guide/quick-start-search/cli-search.md
- docs/src/user-guide/quick-start-cluster-setup/index.md
- docs/src/user-guide/quick-start-compression/json.md
- docs/src/user-guide/quick-start-search/ui-search.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/src/dev-guide/design-kv-ir-streams/background.md
321-321: Line length
Expected: 80; Actual: 96
(MD013, line-length)
docs/src/user-guide/quick-start/setup/main-page.md
19-19: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
docs/src/user-guide/guides/guides-overview.md
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ...rid-item-card} 🔗 guides-multi-node/multi-node Multi-node deployment ^^^ Learn how to deploy CLP ...
(ENGLISH_WORD_REPEAT_RULE)
docs/src/user-guide/index.md
[style] ~22-~22: Consider using a more concise synonym.
Context: ...view Guides ^^^ Guides for using CLP in a variety of use cases. ::: :::{grid-item-card} :li...
(A_VARIETY_OF)
docs/src/user-guide/quick-start/setup/main-page.md
[style] ~22-~22: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uperuser privileges][docker-non-root]. If you're using Docker Desktop, ensure ver...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~27-~27: Try elevating your writing with a more formal expression
Context: ...ome with Python pre-installed, but just to be sure, run the command ``` bash python3 --ve...
(JUST_TO_BE_SURE)
[style] ~36-~36: Try using a more formal synonym here to elevate your writing.
Context: ...install or upgrade it. :::{note} If you're planning on deploying CLP on multiple nodes/systems, there ar...
(PLAN_ON_INTEND)
[uncategorized] ~55-~55: Possible missing comma found.
Context: ... flavour of CLP is appropriate for JSON logs where each log event is an independent ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~92-~92: Possible missing comma found.
Context: ...LP is appropriate for unstructured text logs where each log event contains a timesta...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~112-~112: Possible missing comma found.
Context: ...with a timestamp. The first is a single line while the second contains multiple line...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/src/user-guide/quick-start/clp-text/main-page.md
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[style] ~57-~57: It’s considered informal to use ‘a couple’ without the preposition ‘of’ before a noun.
Context: ...re written as plain text. You can use a couple special characters to make these querie...
(A_COUPLE_OF)
[uncategorized] ~57-~57: Possible missing preposition found.
Context: ...n as plain text. You can use a couple special characters to make these queries more v...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[uncategorized] ~99-~99: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~101-~101: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~106-~106: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~107-~107: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json/main-page.md
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~119-~119: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~126-~126: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~127-~127: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🔇 Additional comments (24)
docs/src/index.md (1)
112-112: Verify corrected datasets link path
Updated the[datasets]reference to include the newresourcessubdirectory. This aligns with the reorganizeduser-guidestructure—just confirm thatresources-datasets.mdlives underuser-guide/resources/.docs/src/user-guide/core/core-unstructured/clp.md (1)
20-20: Link update for schema reference is correct.The relative path
../../reference/reference-unstructured-schema-filecorrectly points from this document to the schema reference in the reorganized directory structure.docs/src/user-guide/guides/guides-using-object-storage/clp-usage.md (1)
4-4: Updated quick-start link targets the JSON flavour.The link to the
clp-jsonquick start guide (../../quick-start/clp-json/main-page) is accurate relative to this document’s location.docs/src/user-guide/guides/guides-overview.md (1)
15-20: New multi-node guide card added successfully.The grid item for multi-node deployment is formatted consistently and the relative link (
guides-multi-node/multi-node) aligns with the new directory layout.🧰 Tools
🪛 LanguageTool
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ...rid-item-card} 🔗 guides-multi-node/multi-node Multi-node deployment ^^^ Learn how to deploy CLP ...(ENGLISH_WORD_REPEAT_RULE)
docs/src/user-guide/core/core-clp-s.md (1)
81-82: Reference links updated to new reference directory.Both instances of
../reference/reference-json-search-syntaxnow correctly resolve to the search syntax reference in the restructured docs.Also applies to: 127-127
docs/src/user-guide/reference/index.md (1)
1-24: New reference index page introduced correctly.The overview grid with cards for JSON search syntax, text search syntax, and schema file syntax is well-structured and uses accurate relative links.
docs/src/dev-guide/design-kv-ir-streams/background.md (1)
14-14: Verify updated relative link
The link to the core CLP-S guide now points to../../user-guide/core/core-clp-s.md, which matches the new directory structure. Confirm that the target file exists at that path.docs/src/user-guide/quick-start/index.md (3)
5-15: Validate setup card link
The:link: setup/main-pagetarget should resolve toquick-start/setup/main-page.md. Ensure that the path is correct and that the card renders as expected in the grid.
18-27: Approve CLP-JSON quick-start card
Content and link (clp-json/main-page) align with PR objectives.
28-33: Approve CLP-Text quick-start card
Content and link (clp-text/main-page) correctly direct users to unstructured-text docs.docs/src/user-guide/guides/guides-multi-node/multi-node.md (3)
113-114: Approve updated guidance
The new prompt to use the quick-start flavour guide is clear and replaces the previous compression/search links.
115-122: Verify CLP-JSON card path
The relative link../../../quick-start/clp-json/main-pageappears correct. Please confirm that the card renders and navigates properly.
125-131: Verify CLP-Text card path
The relative link forclp-textis consistent with the new structure. Double-check that it points toquick-start/clp-text/main-page.md.docs/src/user-guide/guides/guides-using-object-storage/index.md (1)
25-27: Confirm prerequisite link update
The prerequisite now points to the clp-json quick-start guide. Ensure that users understand this is flavour-specific and that multi-flavour support is coming.docs/src/user-guide/quick-start/setup/main-page.md (3)
36-38: Verify multi-node link
The reference to../../guides/guides-multi-node/multi-nodeshould point to the correct multi-node deployment guide. Please confirm that the relative path is accurate.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Try using a more formal synonym here to elevate your writing.
Context: ...install or upgrade it. :::{note} If you're planning on deploying CLP on multiple nodes/systems, there ar...(PLAN_ON_INTEND)
77-86: Verify CLP-JSON portal link
The grid cardi item for JSON flavour (:link: ../clp-json/main-page) looks correct. Confirm that this navigates to the intended page.
90-99: Verify CLP-TEXT portal link
The grid item for unstructured logs (:link: ../clp-text/main-page) aligns with other quick-start pages. Ensure the link renders and works.🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: Possible missing comma found.
Context: ...LP is appropriate for unstructured text logs where each log event contains a timesta...(AI_HYDRA_LEO_MISSING_COMMA)
docs/src/user-guide/index.md (4)
12-12: Ensure the quick-start index link resolves correctly.
Verify thatdocs/src/user-guide/quick-start/index.mdexists at the specified path to prevent broken grid‐item links.
19-19: Verify the new guides overview link.
Confirm thatdocs/src/user-guide/guides/guides-overview.mdexists and renders under “Guides” as expected.
51-55: Double-check quick-start toctree ordering and paths.
Ensure the sequencequick-start/index,quick-start/setup/main-page,quick-start/clp-json/main-page, andquick-start/clp-text/main-pagematches the actual file structure and desired navigation flow.
63-66: Verify multi-node guide path.
Confirm thatguides/guides-multi-node/multi-node.mdexists in the updated “Guides” section.docs/src/user-guide/quick-start/clp-json/main-page.md (1)
85-85: Verify all relative links.
Ensure each../../reference/...and../../guides/...link resolves correctly after the restructure.docs/src/user-guide/quick-start/clp-text/main-page.md (2)
109-112: Verify internal anchor link.
Ensure the anchor#searching-from-the-command-linematches the “Searching from the command line” header.
127-129: Confirm core component link.
Validate that../../core/core-unstructured/indexpoints to the correct “CLP for unstructured logs” page.
docs/src/user-guide/guides/guides-using-object-storage/index.md
Outdated
Show resolved
Hide resolved
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 10
♻️ Duplicate comments (10)
docs/src/user-guide/quick-start/setup/main-page.md (1)
45-47: Consistent casing for flavour names
Headings and list items use lowercaseclp-jsonandclp-text. For brand consistency, consider using uppercaseCLP-JSONandCLP-TEXT.docs/src/user-guide/guides/guides-multi-node/multi-node.md (1)
118-122: Inconsistent casing for flavour names
Grid item card titles use lowercaseclp-jsonandclp-text, but other documentation uses uppercaseCLP-JSONandCLP-TEXT. For brand consistency, update the card titles accordingly.Also applies to: 125-129
docs/src/user-guide/quick-start/clp-json/main-page.md (4)
1-1: Consistent quick-start header.
Rename the page title to “Quick Start: CLP-JSON Logs” to match other flavour-specific quick-start titles.
3-3: Streamline introduction.
Update the opening sentence to “This guide shows you how to start CLP, then compress and search JSON logs.” for brevity and consistency.
19-22: Polish the startup note.
Rephrase to “If CLP fails to start—for example, due to a port conflict—adjust etc/clp-config.yml settings, then retry sbin/start-clp.sh.” for improved clarity.🧰 Tools
🪛 LanguageTool
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...(DUE_TO_BECAUSE)
39-43: Fix admonition indentation under list.
Indent the::{caution}block by four spaces so it nests properly under the preceding list item.docs/src/user-guide/quick-start/clp-text/main-page.md (4)
1-1: Consistent quick-start header.
Rename the page title to “Quick Start: CLP-Text Logs” to align with the JSON quick-start formatting.
3-3: Streamline introduction.
Replace the opening sentence with “This guide shows you how to start CLP, then compress and search unstructured text logs.” for conciseness.
5-7: Simplify caution message.
Shorten and clarify to something like:Note:
clp-textcannot query individual JSON fields; this will be addressed in a future release.🧰 Tools
🪛 LanguageTool
[style] ~6-~6: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs.clp-textis able to compress and search JSON logs as if it ...(BE_ABLE_TO)
19-22: Polish the startup note.
Use the same wording as the JSON guide: “If CLP fails to start—for example, due to a port conflict—adjust etc/clp-config.yml settings, then retry sbin/start-clp.sh.”🧰 Tools
🪛 LanguageTool
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...(DUE_TO_BECAUSE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (7)
docs/src/user-guide/guides/guides-multi-node/multi-node.md(1 hunks)docs/src/user-guide/guides/guides-using-object-storage/clp-usage.md(1 hunks)docs/src/user-guide/index.md(2 hunks)docs/src/user-guide/quick-start/clp-json/main-page.md(1 hunks)docs/src/user-guide/quick-start/clp-text/main-page.md(1 hunks)docs/src/user-guide/quick-start/index.md(1 hunks)docs/src/user-guide/quick-start/setup/main-page.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-guide/quick-start/setup/main-page.md
[style] ~22-~22: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uperuser privileges][docker-non-root]. If you're using Docker Desktop, ensure ver...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~27-~27: Try elevating your writing with a more formal expression
Context: ...ome with Python pre-installed, but just to be sure, run the command ```bash python3 --ver...
(JUST_TO_BE_SURE)
[style] ~36-~36: Try using a more formal synonym here to elevate your writing.
Context: ...install or upgrade it. :::{note} If you're planning on deploying CLP on multiple nodes/systems, there ar...
(PLAN_ON_INTEND)
[uncategorized] ~55-~55: Possible missing comma found.
Context: ... flavour of CLP is appropriate for JSON logs where each log event is an independent ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~92-~92: Possible missing comma found.
Context: ...LP is appropriate for unstructured text logs where each log event contains a timesta...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~112-~112: Possible missing comma found.
Context: ...with a timestamp. The first is a single line while the second contains multiple line...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/src/user-guide/quick-start/clp-text/main-page.md
[style] ~6-~6: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if it ...
(BE_ABLE_TO)
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~99-~99: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~101-~101: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~106-~106: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~107-~107: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json/main-page.md
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~119-~119: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~126-~126: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~127-~127: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/setup/main-page.md
19-19: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
102-102: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/src/user-guide/quick-start/clp-text/main-page.md
55-55: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
78-78: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
101-101: Inline HTML
Element: i
(MD033, no-inline-html)
106-106: Inline HTML
Element: i
(MD033, no-inline-html)
107-107: Inline HTML
Element: i
(MD033, no-inline-html)
docs/src/user-guide/quick-start/clp-json/main-page.md
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
98-98: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
121-121: Inline HTML
Element: i
(MD033, no-inline-html)
126-126: Inline HTML
Element: i
(MD033, no-inline-html)
127-127: Inline HTML
Element: i
(MD033, no-inline-html)
🔇 Additional comments (7)
docs/src/user-guide/guides/guides-using-object-storage/clp-usage.md (1)
4-4: Clarify applicability for unstructured text logs
This section links only to theclp-jsonquick-start. Please confirm whether object storage usage applies to theclp-textflavour as well, and if so, add a link to theclp-textquick-start guide or clarify that this example is JSON-specific.docs/src/user-guide/quick-start/index.md (1)
1-35: Quick-start overview looks good
The new grid layout and links effectively guide users to setup and usage guides.docs/src/user-guide/index.md (1)
11-16: User guide navigation updated correctly
The grid items and toctree entries now reference the new nested documentation structure appropriately.Also applies to: 49-55, 63-66
docs/src/user-guide/quick-start/clp-json/main-page.md (2)
58-58: Link extension removed.
Good catch removing the.mdextension from the datasets link to keep relative paths consistent.
148-149: Verify reference link target.
The link to[CLP for JSON logs](../../core/core-clp-s)may point to a non-existent slug. Please confirm the actual filename or slug and update the path accordingly.docs/src/user-guide/quick-start/clp-text/main-page.md (2)
40-40: Link extension removed.
Good job removing the.mdextension from the datasets link to maintain consistency.
126-129: Verify reference link target.
Check that[CLP for unstructured logs](../../core/core-unstructured/index)points to the correct slug or filename, and update if necessary.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/src/user-guide/quick-start/setup/main-page.md (1)
45-47: 🧹 Nitpick (assertive)Consistent casing for flavour names
The document uses lowercaseclp-jsonandclp-textin list items and headings. For brand consistency, consider using uppercaseCLP-JSONandCLP-TEXTin both the “Choosing a flavour” list and the###headings.
Proposed diff:- * **[clp-json](#clp-json)** for compressing and searching **JSON** logs. + * **[CLP-JSON](#clp-json)** for compressing and searching **JSON** logs. - ### clp-json + ### CLP-JSON - ### clp-text + ### CLP-TEXTAlso applies to: 53-53, 90-90
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-guide/guides/guides-multi-node/multi-node.md(1 hunks)docs/src/user-guide/quick-start/setup/main-page.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-guide/quick-start/setup/main-page.md
[style] ~22-~22: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uperuser privileges][docker-non-root]. If you're using Docker Desktop, ensure ver...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~112-~112: Possible missing comma found.
Context: ...with a timestamp. The first is a single line while the second contains multiple line...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
docs/src/user-guide/guides/guides-multi-node/multi-node.md (1)
113-114: Verify quick-start index link
Please confirm that the relative path../../quick-start/indexcorrectly resolves todocs/src/user-guide/quick-start/index.mdfrom this file’s location.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (12)
docs/src/user-guide/index.md (1)
19-23: Approve revised Guides description
The phrase “Guides for using CLP in various use cases.” is concise and matches prior suggestions.docs/src/user-guide/quick-start/clp-json/main-page.md (5)
58-58: Approve link style correction
The[datasets](../../resources-datasets)link now omits the.mdextension, matching the rest of the docs.
1-2: 🧹 Nitpick (assertive)Optional: Harmonize page title formatting
Consider renaming “# clp-json Quick-start” to “# Quick Start: CLP-JSON Logs” for consistency with other quick-start section titles.
3-3: 🧹 Nitpick (assertive)Optional: Tighten introduction
Replace “This page will walk you through how to start up CLP, and then use it to compress and search JSON logs.” with “This guide shows you how to start CLP, then compress and search JSON logs.”
19-22: 🧹 Nitpick (assertive)Duplicate: Polish startup note phrasing
As previously suggested, rephrase the note to “If CLP fails to start—for example, due to a port conflict—adjustetc/clp-config.ymlsettings, then retrysbin/start-clp.sh.” for clarity.🧰 Tools
🪛 LanguageTool
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...(DUE_TO_BECAUSE)
39-43: 🧹 Nitpick (assertive)Duplicate: Fix admonition indentation under list
Indent the::{caution}block by four spaces so it nests correctly under the<timestamp-key>list item.docs/src/user-guide/quick-start/clp-text/main-page.md (6)
40-41: Approve link style correction
The[datasets](../../resources-datasets)link omitting.mdnow matches the doc-wide convention.
1-1: 🧹 Nitpick (assertive)Optional: Harmonize page title formatting
Consider changing “# clp-text Quick-start” to “# Quick Start: CLP-Text Logs” to match the JSON guide layout.
3-3: 🧹 Nitpick (assertive)Optional: Tighten introduction
Replace “This page will walk you through how to start up CLP, and then use it to compress and search unstructured text logs.” with “This guide shows you how to start CLP, then compress and search unstructured text logs.”
5-7: 🧹 Nitpick (assertive)Optional: Simplify caution message
As suggested previously, shorten the remark to a single line or bullets, e.g.:::::{caution} Note: `clp-text` cannot query individual JSON fields. This will be addressed in a future release. ::::🧰 Tools
🪛 LanguageTool
[style] ~6-~6: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs.clp-textis able to compress and search JSON logs as if it ...(BE_ABLE_TO)
19-22: 🧹 Nitpick (assertive)Duplicate: Align startup note phrasing
Use the same wording as the JSON guide's startup note for consistency: “If CLP fails to start—for example, due to a port conflict—adjustetc/clp-config.ymlsettings, then retrysbin/start-clp.sh.”🧰 Tools
🪛 LanguageTool
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...(DUE_TO_BECAUSE)
83-86: 🧹 Nitpick (assertive)Duplicate: Fix admonition indentation under list
Indent the::{caution}block by four spaces to nest correctly under the--ignore-caselist item.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
docs/src/user-guide/index.md(2 hunks)docs/src/user-guide/quick-start/clp-json/main-page.md(1 hunks)docs/src/user-guide/quick-start/clp-text/main-page.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text/main-page.md
[style] ~6-~6: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if it ...
(BE_ABLE_TO)
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~99-~99: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~101-~101: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~106-~106: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~107-~107: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json/main-page.md
[style] ~20-~20: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~119-~119: Possible missing comma found.
Context: ... can click and drag to zoom into a time range or use the time range filter in (4). 3....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~126-~126: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~127-~127: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🔇 Additional comments (3)
docs/src/user-guide/index.md (3)
12-16: Ensure Quick-start card link accuracy
The updated grid card now points toquick-start/indexand concisely summarizes the flavour-selection, setup, compression, and search steps. Verify that the new overview page exists atdocs/src/user-guide/quick-start/index.mdand displays as intended.
49-55: Confirm Quick-start toctree entries
The toctree now lists four nested paths underquick-start/. Please verify that each file (index,setup/main-page,clp-json/main-page,clp-text/main-page) exists and is properly referenced.
63-66: Confirm Guides toctree entries
The guides section was moved underguides/with paths for overview, object-storage, and multi-node. Ensure thatguides/guides-multi-node/multi-node.mdand the other target files are in place.
There was a problem hiding this comment.
Left some initial comments, but I think this is shaping up.
One thing I noticed while reading through the docs though is that the multi-node deployment docs might be a bit out of date. Specifically, I'm not sure whether a distributed filesystem like seaweedfs is actually required anymore if the package is configured to do everything on S3.
If seaweedfs isn't strictly necessary anymore then we should probably split seaweedfs setup into a separate guide mini-doc like we have for S3 and update the preamble for the multi-node deployment doc to reflect the different options.
Not sure if that's totally accurate/whether it would be appropriate to include those changes in this PR if so, so maybe @kirkrodrigues has some thoughts?
| ## System Requirements | ||
|
|
||
| To run properly on your system, CLP requires a few other programs. Before you set up CLP, ensure that you have the following installed. | ||
|
|
||
| ### Docker | ||
|
|
||
| CLP uses Docker to deploy its different components. You can check whether Docker is already installed on your system by running the command | ||
|
|
||
| ```bash | ||
| docker version | ||
| ``` | ||
|
|
||
| If Docker is not on your system, follow the instructions [here][Docker] to install it. | ||
|
|
||
| If you're not running as root, ensure Docker can be run [without superuser privileges][docker-non-root]. | ||
|
|
||
| If you're using Docker Desktop, ensure version 4.34 or higher is installed, and [host networking is enabled][docker-desktop-host-networking]. | ||
|
|
||
| ### Python | ||
|
|
||
| CLP uses Python to interpret the scripts that coordinate how it runs. Specifically, CLP needs Python version 3.8 or higher. Many Linux distributions come with Python pre-installed; to confirm that it's on your system, run the command | ||
|
|
||
| ```bash | ||
| python3 --version | ||
| ``` | ||
|
|
||
| If Python isn't on your system, or if the version isn't high enough, install or upgrade it. | ||
|
|
||
| :::{note} | ||
| If you're planning to deploy CLP on multiple nodes/systems, there are a few other system requirements; check out the [multi-node deployment](../../guides/guides-multi-node/multi-node) page for more details. | ||
| ::: |
There was a problem hiding this comment.
I think I kind of like this, but I'm not sure whether it's better to have all of this detail or just have concise bullet points like we do for the multi-node deployment doc. Maybe @kirkrodrigues has an opinion?
There was a problem hiding this comment.
ah I see your concern. the way I see it, people using the multi-node deployment doc will probably be (on average) more computer-savvy than people using this doc, so point form is more appropriate there. I could get behind a reduction of this section though (maybe the "CLP uses..." sections could go, as they're kind of just icing). @kirkrodrigues what do you think?
Co-authored-by: Devin Gibson <gibber9809@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/src/user-guide/quick-start/clp-text.md (4)
1-1: Rename heading for consistency with other guides
Aligns with earlier feedback on matching the pattern “clp-text quick-start guide”.-# clp-text quick-start +# clp-text quick-start guide
6-10: Simplify caution wording & use “flavour” terminology
Previous comments still apply—replace “is able to” and “release” for concision and consistency.-If you're using a `clp-text` release, you should only compress unstructured text logs. `clp-text` -is able to compress and search JSON logs as if it was unstructured text, but `clp-text` cannot -query individual fields. This limitation will be addressed in a future version of CLP. +If you're using the `clp-text` flavour, compress only unstructured text logs. `clp-text` +can compress and search JSON logs as unstructured text, but it cannot query individual +fields. This limitation will be addressed in a future CLP version.
22-25: Remove “try” for clearer troubleshooting guidance
The note still has the tentative phrasing flagged earlier.-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun the start command.
111-117: Replace raw HTML icon tags to satisfy MD033 & improve accessibility
Inline<i>tags are still present; switch to Unicode or a Sphinx icon directive.-4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters for your query. +4. Clicking the 📋 icon reveals additional filters for your query. @@ -5. Clicking the <i class="fa fa-cog"></i> icon reveals options for displaying results. -6. The <i class="fa fa-trash"></i> icon clears the results of the last query. +5. Clicking the ⚙️ icon reveals options for displaying results. +6. The 🗑️ icon clears the results of the last query.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-text.md (23)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if it ...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...y in Figure 2. (figure-1)= :::{card} ```text 1 abc 2 axbc 3 ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~111-~111: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~116-~116: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~117-~117: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-text.md
60-60: Link fragments should be valid
(MD051, link-fragments)
60-60: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
111-111: Inline HTML
Element: i
(MD033, no-inline-html)
116-116: Inline HTML
Element: i
(MD033, no-inline-html)
117-117: Inline HTML
Element: i
(MD033, no-inline-html)
145-145: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: lint-check (macos-latest)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (9)
docs/src/user-guide/quick-start/clp-json.md (4)
1-1: Rename heading for consistency
Other quick-start docs use “… quick-start guide”; rename to stay consistent.
20-23: Remove “try” for crisper troubleshooting-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun `sbin/start-clp.sh`.
5-8: Use “flavour” instead of “release”-If you're using a `clp-json` release, you can only compress and search JSON logs. +If you're using the `clp-json` flavour, you can only compress and search JSON logs.
133-140: Replace raw<i>tags to satisfy MD033The inline FontAwesome tags break markdown-lint and hinder accessibility. Swap them for Unicode (e.g., ☰ ⚙️ 🗑️) or the Sphinx
:fa-…:role.docs/src/user-guide/quick-start/clp-text.md (5)
1-1: Rename heading for consistency
Align with other docs: “clp-text quick-start guide”.
7-10: Shorten and standardise caution wording-If you're using a `clp-text` release, you should only compress unstructured text logs. `clp-text` -is able to compress and search JSON logs as if it was unstructured text, but `clp-text` cannot -query individual fields. This limitation will be addressed in a future version of CLP. +If you're using the `clp-text` flavour, compress only unstructured text logs. `clp-text` +can treat JSON logs as text but cannot query individual fields. This limitation will be addressed in a future CLP version.
22-25: Remove “try” for clearer instruction-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun `sbin/start-clp.sh`.
111-118: Swap raw<i>icons for Unicode / Sphinx roleReplace
<i class="fa …">tags with emoji or:fa-…:to satisfy MD033 and improve accessibility.
145-146: Remove surplus blank line (MD012)- --- +---
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-guide/quick-start/clp-json.md(1 hunks)docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-text.md (23)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
docs/src/user-guide/quick-start/clp-json.md (30)
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.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:629-733
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In the `JsonParser::parse_kv_log_event` method in `components/core/src/clp_s/JsonParser.cpp`, prefer passing exceptions to higher levels for more graceful handling, rather than handling them at that level.
Learnt from: LinZhihao-723
PR: y-scope/clp#558
File: components/core/tests/test-ffi_KeyValuePairLogEvent.cpp:14-14
Timestamp: 2024-10-14T03:42:10.355Z
Learning: In the file `components/core/tests/test-ffi_KeyValuePairLogEvent.cpp`, including `<json/single_include/nlohmann/json.hpp>` is consistent with the project's coding standards.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:756-765
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir()` function, reaching the end of log events in a given IR is not considered an error case. The errors `std::errc::no_message_available` and `std::errc::result_out_of_range` are expected signals to break the deserialization loop and proceed accordingly.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: haiqi96
PR: y-scope/clp#619
File: components/core/src/clp/clp/decompression.cpp:313-313
Timestamp: 2024-12-05T16:32:21.507Z
Learning: In the C++ `FileDecompressor` implementations at `components/core/src/clp/clp/FileDecompressor.cpp` and `components/core/src/glt/glt/FileDecompressor.cpp`, the `temp_output_path` variable and associated logic are used to handle multiple compressed files with the same name, and should be kept. This logic is separate from the temporary output directory code removed in PR #619 and is necessary for proper file handling.
Learnt from: AVMatthews
PR: y-scope/clp#595
File: components/core/tests/test-end_to_end.cpp:59-65
Timestamp: 2024-11-19T17:30:04.970Z
Learning: In 'components/core/tests/test-end_to_end.cpp', during the 'clp-s_compression_and_extraction_no_floats' test, files and directories are intentionally removed at the beginning of the test to ensure that any existing content doesn't influence the test results.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: junhaoliao
PR: y-scope/clp#988
File: components/log-viewer-webui/client/src/components/QueryBox/InputWithCaseSensitive/CaseSenstiveToggle.tsx:34-37
Timestamp: 2025-06-09T17:48:56.024Z
Learning: In the y-scope/clp project, prefer `false == <expression>` rather than `!<expression>` for boolean expressions in TypeScript/JavaScript files, as specified in the coding guidelines.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: LinZhihao-723
PR: y-scope/clp#593
File: components/core/tests/test-NetworkReader.cpp:216-219
Timestamp: 2024-11-15T03:15:45.919Z
Learning: In the `network_reader_with_valid_http_header_kv_pairs` test case in `components/core/tests/test-NetworkReader.cpp`, additional error handling for JSON parsing failures is not necessary, as the current error message is considered sufficient.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if it ...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...y in Figure 2. (figure-1)= :::{card} ```text 1 abc 2 axbc 3 ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~111-~111: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~116-~116: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~117-~117: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json.md
[style] ~21-~21: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~76-~76: A punctuation mark might be missing here.
Context: ...y in Figure 2. (figure-1)= :::{card} ```json lines { "t": { ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~133-~133: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~138-~138: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~139-~139: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-text.md
60-60: Link fragments should be valid
(MD051, link-fragments)
60-60: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
111-111: Inline HTML
Element: i
(MD033, no-inline-html)
116-116: Inline HTML
Element: i
(MD033, no-inline-html)
117-117: Inline HTML
Element: i
(MD033, no-inline-html)
145-145: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
docs/src/user-guide/quick-start/clp-json.md
60-60: Link fragments should be valid
(MD051, link-fragments)
60-60: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
111-111: Inline HTML
Element: i
(MD033, no-inline-html)
116-116: Inline HTML
Element: i
(MD033, no-inline-html)
117-117: Inline HTML
Element: i
(MD033, no-inline-html)
145-145: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/src/user-guide/quick-start/clp-text.md (4)
1-1: Heading still inconsistent with other quick-start guides
Other guides use “… quick-start guide”. Rename for consistency.
6-10: Refine caution wording & terminology
Replace “release” → “flavour” and “is able to” → “can” for brevity / consistency.-If you're using a `clp-text` release, you should only compress unstructured text logs. `clp-text` -is able to compress and search JSON logs as if it was unstructured text, but `clp-text` cannot +If you're using the `clp-text` flavour, compress only unstructured text logs. `clp-text` +can search JSON logs as unstructured text, but it cannot
22-25: Remove “try” for clearer instructions
Direct imperative is preferred in docs.-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun the command.
111-117: Inline HTML icons still trigger MD033; use Unicode or a Sphinx directive-4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters for your query. +4. Clicking the 📋 icon reveals additional filters for your query. @@ -5. Clicking the <i class="fa fa-cog"></i> icon reveals options for displaying results. -6. The <i class="fa fa-trash"></i> icon clears the results of the last query. +5. Clicking the ⚙️ icon reveals options for displaying results. +6. The 🗑️ icon clears the results of the last query.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-text.md (23)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if it ...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...y in Figure 2. (figure-1)= :::{card} ```text 1 abc 2 axbc 3 ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~111-~111: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~116-~116: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~117-~117: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-text.md
60-60: Link fragments should be valid
(MD051, link-fragments)
60-60: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
88-88: Link fragments should be valid
(MD051, link-fragments)
111-111: Inline HTML
Element: i
(MD033, no-inline-html)
116-116: Inline HTML
Element: i
(MD033, no-inline-html)
117-117: Inline HTML
Element: i
(MD033, no-inline-html)
🔇 Additional comments (1)
docs/src/user-guide/quick-start/clp-text.md (1)
58-61: Static-analysis flags invalid fragment links – verify anchors build correctly
markdownlintreports MD051 for#figure-1/#figure-2even though anchors appear to be defined. Please build the docs locally to ensure Sphinx resolves these references; add explicit{numref}labels if needed.Also applies to: 88-90
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (8)
docs/src/user-guide/quick-start/clp-json.md (3)
1-1: Heading still not aligned with established naming convention
Heading should read “clp-json quick-start guide” to match other guides.
21-23: Remove “try” for clearer troubleshooting instruction
Rephrase to “adjust the settings … and run the start command again.”
134-140: Inline HTML icons still violate MD033
Replace<i class="fa …">tags with Unicode (📊 ⚙️ 🗑️) or a Sphinx icon directive.docs/src/user-guide/quick-start/clp-text.md (5)
1-1: Heading inconsistent with other guides
Rename to “clp-text quick-start guide”.
7-9: Simplify caution wording & use “flavor”
Change “release” → “flavor” and “is able to” → “can”.
22-25: Remove “try” for direct instruction
Use “… adjust the settings … and rerun …”.
116-122: Inline HTML icons break lint rules
Swap the<i class="fa …">tags for Unicode symbols or Sphinx icons.
106-108: Image missing alt-text (accessibility & MD033 clean-up)-:::{image} clp-search-ui.png -::: +:::{image} clp-search-ui.png +:alt: Screenshot of CLP’s search UI with numbered annotations +:::
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-guide/quick-start/clp-json.md(1 hunks)docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-json.md (31)
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.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:629-733
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In the `JsonParser::parse_kv_log_event` method in `components/core/src/clp_s/JsonParser.cpp`, prefer passing exceptions to higher levels for more graceful handling, rather than handling them at that level.
Learnt from: LinZhihao-723
PR: y-scope/clp#558
File: components/core/tests/test-ffi_KeyValuePairLogEvent.cpp:14-14
Timestamp: 2024-10-14T03:42:10.355Z
Learning: In the file `components/core/tests/test-ffi_KeyValuePairLogEvent.cpp`, including `<json/single_include/nlohmann/json.hpp>` is consistent with the project's coding standards.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:756-765
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir()` function, reaching the end of log events in a given IR is not considered an error case. The errors `std::errc::no_message_available` and `std::errc::result_out_of_range` are expected signals to break the deserialization loop and proceed accordingly.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: haiqi96
PR: y-scope/clp#619
File: components/core/src/clp/clp/decompression.cpp:313-313
Timestamp: 2024-12-05T16:32:21.507Z
Learning: In the C++ `FileDecompressor` implementations at `components/core/src/clp/clp/FileDecompressor.cpp` and `components/core/src/glt/glt/FileDecompressor.cpp`, the `temp_output_path` variable and associated logic are used to handle multiple compressed files with the same name, and should be kept. This logic is separate from the temporary output directory code removed in PR #619 and is necessary for proper file handling.
Learnt from: AVMatthews
PR: y-scope/clp#595
File: components/core/tests/test-end_to_end.cpp:59-65
Timestamp: 2024-11-19T17:30:04.970Z
Learning: In 'components/core/tests/test-end_to_end.cpp', during the 'clp-s_compression_and_extraction_no_floats' test, files and directories are intentionally removed at the beginning of the test to ensure that any existing content doesn't influence the test results.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: junhaoliao
PR: y-scope/clp#988
File: components/log-viewer-webui/client/src/components/QueryBox/InputWithCaseSensitive/CaseSenstiveToggle.tsx:34-37
Timestamp: 2025-06-09T17:48:56.024Z
Learning: In the y-scope/clp project, prefer `false == <expression>` rather than `!<expression>` for boolean expressions in TypeScript/JavaScript files, as specified in the coding guidelines.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: LinZhihao-723
PR: y-scope/clp#593
File: components/core/tests/test-NetworkReader.cpp:216-219
Timestamp: 2024-11-15T03:15:45.919Z
Learning: In the `network_reader_with_valid_http_header_kv_pairs` test case in `components/core/tests/test-NetworkReader.cpp`, additional error handling for JSON parsing failures is not necessary, as the current error message is considered sufficient.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that divide the card header from the card body content. Everything before `^^^` becomes the card header, and everything after becomes the card body. These separators are essential for proper card formatting and should never be removed.
docs/src/user-guide/quick-start/clp-text.md (24)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
Learnt from: LinZhihao-723
PR: y-scope/clp#882
File: components/core/src/clp/ffi/ir_stream/search/QueryHandlerImpl.cpp:378-402
Timestamp: 2025-05-07T16:56:35.687Z
Learning: In the CLP search component, the `evaluate_wildcard_filter` function should return `AstEvaluationResult::Pruned` when `node_id_value_pairs` is empty, not `AstEvaluationResult::False`. Empty node sets should be treated as "undetermined" rather than definitive non-matches.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-json.md
[style] ~21-~21: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~77-~77: A punctuation mark might be missing here.
Context: ...t in Figure 2. (figure-1)= :::{card} ```sql ctx: "conn11" AND msg:...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~134-~134: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~139-~139: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~140-~140: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if the...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~65-~65: A punctuation mark might be missing here.
Context: ...s in Figure 2. (figure-1)= :::{card} ```bash "INFO container_? Tra...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~116-~116: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~122-~122: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-json.md
74-74: Link fragments should be valid
(MD051, link-fragments)
75-75: Link fragments should be valid
(MD051, link-fragments)
111-111: Link fragments should be valid
(MD051, link-fragments)
134-134: Inline HTML
Element: i
(MD033, no-inline-html)
139-139: Inline HTML
Element: i
(MD033, no-inline-html)
140-140: Inline HTML
Element: i
(MD033, no-inline-html)
docs/src/user-guide/quick-start/clp-text.md
63-63: Link fragments should be valid
(MD051, link-fragments)
63-63: Link fragments should be valid
(MD051, link-fragments)
93-93: Link fragments should be valid
(MD051, link-fragments)
116-116: Inline HTML
Element: i
(MD033, no-inline-html)
121-121: Inline HTML
Element: i
(MD033, no-inline-html)
122-122: Inline HTML
Element: i
(MD033, no-inline-html)
quinntaylormitchell
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (10)
docs/src/user-guide/quick-start/clp-json.md (5)
1-1: Rename heading to include “guide”.
The other quick-start docs include “guide” in their titles (e.g., “quick-start guide”). For consistency, rename this heading to “clp-json quick-start guide”.
6-8: Use “flavor” instead of “release”.
Project terminology everywhere else uses flavor; please switch the wording in this caution box.
20-23: Drop “try” for clearer instruction.“… try adjusting the settings…” → “… adjust the settings…”.
Same change requested earlier for clp-text.
124-126: Add descriptive alt-text for accessibility (MD033, WCAG).-:::{image} clp-search-ui.png -::: +:::{image} clp-search-ui.png +:alt: Screenshot of CLP’s web UI with numbered call-outs +:::
134-140: Replace raw<i>tags with Unicode or Sphinx icons.Markdown-lint (MD033) still flags these. Example fix:
-4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters +4. Clicking the ☰ icon reveals additional filtersApply similarly for the cog (⚙️) and trash (🗑️) icons.
docs/src/user-guide/quick-start/clp-text.md (5)
1-1: Align heading with naming convention.
Rename to “clp-text quick-start guide” for parity with other guides.
6-10: Terminology & phrasing clean-up.
- “
clp-textrelease” → “clp-textflavour”.- Replace is able to with can for brevity.
-If you're using a `clp-text` release, you should only compress ... -`clp-text` is able to compress and search JSON logs ... +If you're using the `clp-text` flavor, compress only ... +`clp-text` can compress and search JSON logs ...
22-25: Remove tentative wording in troubleshooting note.-... try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +... adjust the settings in `etc/clp-config.yml` and rerun `sbin/start-clp.sh`.
105-106: Provide alt-text for the UI screenshot.-:::{image} clp-search-ui.png -::: +:::{image} clp-search-ui.png +:alt: Screenshot of CLP’s web UI with numbered call-outs +:::
115-121: Inline HTML icons trigger MD033.
Replace the<i class="fa ...">tags with Unicode symbols or Sphinx icon directives as suggested for the JSON guide.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-guide/quick-start/clp-json.md(1 hunks)docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-text.md (24)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
Learnt from: LinZhihao-723
PR: y-scope/clp#882
File: components/core/src/clp/ffi/ir_stream/search/QueryHandlerImpl.cpp:378-402
Timestamp: 2025-05-07T16:56:35.687Z
Learning: In the CLP search component, the `evaluate_wildcard_filter` function should return `AstEvaluationResult::Pruned` when `node_id_value_pairs` is empty, not `AstEvaluationResult::False`. Empty node sets should be treated as "undetermined" rather than definitive non-matches.
docs/src/user-guide/quick-start/clp-json.md (31)
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.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:629-733
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In the `JsonParser::parse_kv_log_event` method in `components/core/src/clp_s/JsonParser.cpp`, prefer passing exceptions to higher levels for more graceful handling, rather than handling them at that level.
Learnt from: LinZhihao-723
PR: y-scope/clp#558
File: components/core/tests/test-ffi_KeyValuePairLogEvent.cpp:14-14
Timestamp: 2024-10-14T03:42:10.355Z
Learning: In the file `components/core/tests/test-ffi_KeyValuePairLogEvent.cpp`, including `<json/single_include/nlohmann/json.hpp>` is consistent with the project's coding standards.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:756-765
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir()` function, reaching the end of log events in a given IR is not considered an error case. The errors `std::errc::no_message_available` and `std::errc::result_out_of_range` are expected signals to break the deserialization loop and proceed accordingly.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: haiqi96
PR: y-scope/clp#619
File: components/core/src/clp/clp/decompression.cpp:313-313
Timestamp: 2024-12-05T16:32:21.507Z
Learning: In the C++ `FileDecompressor` implementations at `components/core/src/clp/clp/FileDecompressor.cpp` and `components/core/src/glt/glt/FileDecompressor.cpp`, the `temp_output_path` variable and associated logic are used to handle multiple compressed files with the same name, and should be kept. This logic is separate from the temporary output directory code removed in PR #619 and is necessary for proper file handling.
Learnt from: AVMatthews
PR: y-scope/clp#595
File: components/core/tests/test-end_to_end.cpp:59-65
Timestamp: 2024-11-19T17:30:04.970Z
Learning: In 'components/core/tests/test-end_to_end.cpp', during the 'clp-s_compression_and_extraction_no_floats' test, files and directories are intentionally removed at the beginning of the test to ensure that any existing content doesn't influence the test results.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: junhaoliao
PR: y-scope/clp#988
File: components/log-viewer-webui/client/src/components/QueryBox/InputWithCaseSensitive/CaseSenstiveToggle.tsx:34-37
Timestamp: 2025-06-09T17:48:56.024Z
Learning: In the y-scope/clp project, prefer `false == <expression>` rather than `!<expression>` for boolean expressions in TypeScript/JavaScript files, as specified in the coding guidelines.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: LinZhihao-723
PR: y-scope/clp#593
File: components/core/tests/test-NetworkReader.cpp:216-219
Timestamp: 2024-11-15T03:15:45.919Z
Learning: In the `network_reader_with_valid_http_header_kv_pairs` test case in `components/core/tests/test-NetworkReader.cpp`, additional error handling for JSON parsing failures is not necessary, as the current error message is considered sufficient.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that divide the card header from the card body content. Everything before `^^^` becomes the card header, and everything after becomes the card body. These separators are essential for proper card formatting and should never be removed.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if the...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~65-~65: A punctuation mark might be missing here.
Context: ...s in Figure 2. (figure-1)= :::{card} ```bash "INFO container_? Tra...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~115-~115: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~120-~120: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json.md
[style] ~21-~21: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~77-~77: A punctuation mark might be missing here.
Context: ...t in Figure 2. (figure-1)= :::{card} ```sql ctx: "conn11" AND msg:...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~134-~134: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~139-~139: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~140-~140: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-text.md
63-63: Link fragments should be valid
(MD051, link-fragments)
63-63: Link fragments should be valid
(MD051, link-fragments)
93-93: Link fragments should be valid
(MD051, link-fragments)
115-115: Inline HTML
Element: i
(MD033, no-inline-html)
120-120: Inline HTML
Element: i
(MD033, no-inline-html)
121-121: Inline HTML
Element: i
(MD033, no-inline-html)
docs/src/user-guide/quick-start/clp-json.md
74-74: Link fragments should be valid
(MD051, link-fragments)
75-75: Link fragments should be valid
(MD051, link-fragments)
111-111: Link fragments should be valid
(MD051, link-fragments)
134-134: Inline HTML
Element: i
(MD033, no-inline-html)
139-139: Inline HTML
Element: i
(MD033, no-inline-html)
140-140: Inline HTML
Element: i
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: lint-check (macos-latest)
🔇 Additional comments (1)
docs/src/user-guide/quick-start/clp-json.md (1)
111-114: Incorrect figure reference.
The sentence should refer to Figure 1 (query), not Figure 2 (logs).-The query in [Figure 2](#figure-2) will match log events that contain ... +The query in [Figure 1](#figure-1) will match log events that contain ...Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (10)
docs/src/user-guide/quick-start/clp-text.md (5)
1-1: Heading still missing “guide” suffix
This was previously flagged; renaming the heading to “clp-text quick-start guide” keeps titles consistent with the other flavour pages.
6-10: Update wording & terminology (“flavour”, “can”, plural agreement)
Prior review already requested:-If you're using a `clp-text` release, you should only compress unstructured text logs. `clp-text` -is able to compress and search JSON logs as if they were unstructured text, but `clp-text` cannot -query individual fields. This limitation will be addressed in a future version of CLP. +If you’re using the `clp-text` flavour, compress only unstructured text logs. `clp-text` +can compress and search JSON logs as unstructured text, but it cannot query individual +fields. This limitation will be addressed in a future CLP version.
22-25: Remove “try” for clearer troubleshooting note
Earlier comment suggested eliminating the hedge:-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun `sbin/start-clp.sh`.
105-107: Add alt-text to the image for accessibility
The image block still lacks an:alt:field. Please add descriptive alt-text as previously requested.
115-121: Inline HTML icons still violate MD033
Replace the three<i class="fa …"></i>tags with Unicode (e.g., 📋 / ⚙️ / 🗑️) or a Sphinx icon directive to satisfy markdownlint and improve accessibility.docs/src/user-guide/quick-start/clp-json.md (5)
1-1: Rename heading for consistency across quick-start docsOther guides follow the “<flavour> quick-start guide” pattern (e.g., clp-text quick-start guide).
Rename to keep titles aligned.-# clp-json quick-start +# clp-json quick-start guide
5-8: Use “flavour” instead of “release”Project terminology elsewhere prefers flavour; keeping two terms defeats the clarification this PR aims for.
-If you're using a `clp-json` release, you can only compress and search JSON logs. +If you're using the `clp-json` flavour, you can only compress and search JSON logs.
20-23: Drop the tentative “try” for clearer guidanceDirect instructions read better and avoid hedging.
-If CLP fails to start (e.g., due to a port conflict), try adjusting the settings in -`etc/clp-config.yml` and then run the start command again. +If CLP fails to start (e.g., due to a port conflict), adjust the settings in +`etc/clp-config.yml` and rerun `sbin/start-clp.sh`.
124-126: Add descriptive alt-text for accessibilityScreen-reader users won’t know what the UI image contains.
-:::{image} clp-search-ui.png -::: +:::{image} clp-search-ui.png +:alt: Screenshot of CLP’s web UI with numbered call-outs +:::
134-140: Replace raw FontAwesome<i>tagsInline HTML violates MD033 and breaks when FontAwesome isn’t loaded.
Consider Sphinx:material-*:,:octicon-*:, or plain Unicode.-4. Clicking the <i class="fa fa-bars"></i> icon reveals additional filters for your query. +4. Clicking the ☰ icon reveals additional filters for your query. @@ -5. Clicking the <i class="fa fa-cog"></i> icon reveals options for displaying results. -6. The <i class="fa fa-trash"></i> icon clears the results of the last query. +5. Clicking the ⚙️ icon reveals options for displaying results. +6. The 🗑️ icon clears the results of the last query.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/src/user-guide/quick-start/clp-json.md(1 hunks)docs/src/user-guide/quick-start/clp-text.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: gibber9809
PR: y-scope/clp#504
File: components/core/src/clp_s/search/kql/CMakeLists.txt:29-29
Timestamp: 2024-10-22T15:36:04.655Z
Learning: When reviewing pull requests, focus on the changes within the PR and avoid commenting on issues outside the scope of the PR.
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.
docs/src/user-guide/quick-start/clp-text.md (24)
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/docker-images/clp-env-base-musllinux_1_2-x86/build.sh:18-24
Timestamp: 2025-07-01T14:52:02.418Z
Learning: In the CLP project, consistency across platform build scripts is prioritized over defensive programming when it comes to git remote handling. All build.sh files in docker-images directories should follow the same pattern for git metadata injection.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
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.
Learnt from: LinZhihao-723
PR: y-scope/clp#882
File: components/core/src/clp/ffi/ir_stream/search/QueryHandlerImpl.cpp:378-402
Timestamp: 2025-05-07T16:56:35.687Z
Learning: In the CLP search component, the `evaluate_wildcard_filter` function should return `AstEvaluationResult::Pruned` when `node_id_value_pairs` is empty, not `AstEvaluationResult::False`. Empty node sets should be treated as "undetermined" rather than definitive non-matches.
docs/src/user-guide/quick-start/clp-json.md (31)
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.
Learnt from: Bill-hbrhbr
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-03-18T07:27:54.738Z
Learning: Double parentheses in the codebase are intentional and required for clang-tidy to pass. These should not be flagged as style issues in code reviews.
Learnt from: haiqi96
PR: y-scope/clp#594
File: components/clp-package-utils/clp_package_utils/scripts/del_archives.py:56-65
Timestamp: 2024-11-18T16:49:20.248Z
Learning: When reviewing wrapper scripts in `components/clp-package-utils/clp_package_utils/scripts/`, note that it's preferred to keep error handling simple without adding extra complexity.
Learnt from: quinntaylormitchell
PR: y-scope/clp#961
File: docs/src/dev-guide/design-clp-structured/single-file-archive-format.md:216-219
Timestamp: 2025-06-18T14:35:20.485Z
Learning: In clp-s documentation, technical abbreviations like "MPT" (Merged Parse Tree) should be defined at first use to improve reader clarity and comprehension.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-packages-from-source.sh:6-8
Timestamp: 2025-07-01T14:51:19.172Z
Learning: In CLP installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistency with existing variable declaration patterns across platforms rather than adding individual improvements like `readonly` declarations.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that create underlines/visual separators between the card title and card content/description. They should not be removed as they are part of the proper MyST syntax for Sphinx documentation.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/ubuntu-jammy/install-prebuilt-packages.sh:35-41
Timestamp: 2025-05-06T09:48:55.408Z
Learning: For installation scripts in the CLP project, prefer explicit error handling over automatic dependency resolution (like `apt-get install -f`) when installing packages to give users more control over their system.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across platforms rather than applying platform-specific optimizations. When a platform follows a pattern of separate update and install commands (like `apt-get update && apt-get install` or `apk update && apk add`), preserve this pattern for uniform script structure.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:769-779
Timestamp: 2024-10-07T21:16:41.660Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, when handling errors in `parse_from_ir`, prefer to maintain the current mix of try-catch and if-statements because specific messages are returned back up in some cases.
Learnt from: jackluo923
PR: y-scope/clp#1054
File: components/core/tools/scripts/lib_install/musllinux_1_2/install-prebuilt-packages.sh:6-15
Timestamp: 2025-07-01T14:52:15.217Z
Learning: For installation scripts in the CLP project, maintain consistency in command patterns across different platforms (e.g., using separate update and install commands like `apk update && apk add`, `apt update && apt install`, `yum update && yum install`) rather than platform-specific optimizations, to ensure uniform script structure and readability.
Learnt from: kirkrodrigues
PR: y-scope/clp#881
File: components/core/tools/scripts/lib_install/macos/install-all.sh:11-12
Timestamp: 2025-05-06T10:07:04.654Z
Learning: In CLP installation scripts, temporary directories with downloaded files should not be automatically cleaned up on failure (e.g., with EXIT traps) to preserve artifacts for debugging purposes.
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.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:53-54
Timestamp: 2025-06-18T20:48:48.990Z
Learning: CLP is designed to run on Linux systems where Python is typically pre-installed, so Python installation links are generally not needed in CLP documentation.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:735-794
Timestamp: 2024-10-07T21:35:04.362Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir` method, encountering errors from `kv_log_event_result.error()` aside from `std::errc::no_message_available` and `std::errc::result_out_of_range` is anticipated behavior and does not require additional error handling or logging.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:629-733
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In the `JsonParser::parse_kv_log_event` method in `components/core/src/clp_s/JsonParser.cpp`, prefer passing exceptions to higher levels for more graceful handling, rather than handling them at that level.
Learnt from: LinZhihao-723
PR: y-scope/clp#558
File: components/core/tests/test-ffi_KeyValuePairLogEvent.cpp:14-14
Timestamp: 2024-10-14T03:42:10.355Z
Learning: In the file `components/core/tests/test-ffi_KeyValuePairLogEvent.cpp`, including `<json/single_include/nlohmann/json.hpp>` is consistent with the project's coding standards.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/JsonParser.cpp:756-765
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `parse_from_ir()` function, reaching the end of log events in a given IR is not considered an error case. The errors `std::errc::no_message_available` and `std::errc::result_out_of_range` are expected signals to break the deserialization loop and proceed accordingly.
Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.
Learnt from: haiqi96
PR: y-scope/clp#619
File: components/core/src/clp/clp/decompression.cpp:313-313
Timestamp: 2024-12-05T16:32:21.507Z
Learning: In the C++ `FileDecompressor` implementations at `components/core/src/clp/clp/FileDecompressor.cpp` and `components/core/src/glt/glt/FileDecompressor.cpp`, the `temp_output_path` variable and associated logic are used to handle multiple compressed files with the same name, and should be kept. This logic is separate from the temporary output directory code removed in PR #619 and is necessary for proper file handling.
Learnt from: AVMatthews
PR: y-scope/clp#595
File: components/core/tests/test-end_to_end.cpp:59-65
Timestamp: 2024-11-19T17:30:04.970Z
Learning: In 'components/core/tests/test-end_to_end.cpp', during the 'clp-s_compression_and_extraction_no_floats' test, files and directories are intentionally removed at the beginning of the test to ensure that any existing content doesn't influence the test results.
Learnt from: gibber9809
PR: y-scope/clp#955
File: components/core/src/clp_s/search/sql/CMakeLists.txt:8-26
Timestamp: 2025-06-02T18:22:24.060Z
Learning: In the clp project, ANTLR code generation at build time is being removed by another PR. When reviewing CMake files, be aware that some temporary suboptimal configurations may exist to reduce merge conflicts between concurrent PRs, especially around ANTLR_TARGET calls.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-07T20:10:08.254Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: AVMatthews
PR: y-scope/clp#543
File: components/core/src/clp_s/clp-s.cpp:196-265
Timestamp: 2024-10-08T15:52:50.753Z
Learning: In `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of IR files, making it difficult to restructure it into separate functions.
Learnt from: junhaoliao
PR: y-scope/clp#988
File: components/log-viewer-webui/client/src/components/QueryBox/InputWithCaseSensitive/CaseSenstiveToggle.tsx:34-37
Timestamp: 2025-06-09T17:48:56.024Z
Learning: In the y-scope/clp project, prefer `false == <expression>` rather than `!<expression>` for boolean expressions in TypeScript/JavaScript files, as specified in the coding guidelines.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:08.691Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, within the `get_archive_node_id` function, validation and exception throwing for UTF-8 compliance of `curr_node.get_key_name()` are unnecessary and should be omitted.
Learnt from: LinZhihao-723
PR: y-scope/clp#593
File: components/core/tests/test-NetworkReader.cpp:216-219
Timestamp: 2024-11-15T03:15:45.919Z
Learning: In the `network_reader_with_valid_http_header_kv_pairs` test case in `components/core/tests/test-NetworkReader.cpp`, additional error handling for JSON parsing failures is not necessary, as the current error message is considered sufficient.
Learnt from: gibber9809
PR: y-scope/clp#630
File: components/core/src/clp_s/JsonParser.cpp:702-703
Timestamp: 2024-12-10T16:03:13.322Z
Learning: In `components/core/src/clp_s/JsonParser.cpp`, validation and exception throwing are unnecessary in the `get_archive_node_id` method when processing nodes, and should not be added.
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/index.md:14-14
Timestamp: 2025-06-18T20:36:57.424Z
Learning: In MyST markdown grid-item-card syntax, the `^^^` symbols are intentional separators that divide the card header from the card body content. Everything before `^^^` becomes the card header, and everything after becomes the card body. These separators are essential for proper card formatting and should never be removed.
🪛 LanguageTool
docs/src/user-guide/quick-start/clp-text.md
[style] ~7-~7: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ress unstructured text logs. clp-text is able to compress and search JSON logs as if the...
(BE_ABLE_TO)
[style] ~23-~23: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~65-~65: A punctuation mark might be missing here.
Context: ...s in Figure 2. (figure-1)= :::{card} ```bash "INFO container_? Tra...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~115-~115: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~120-~120: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~121-~121: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
docs/src/user-guide/quick-start/clp-json.md
[style] ~21-~21: This wording can make your sentence hard to follow. Try rephrasing for improved clarity.
Context: ...` :::{note} If CLP fails to start (e.g., due to a port conflict), try adjusting the set...
(DUE_TO_BECAUSE)
[uncategorized] ~77-~77: A punctuation mark might be missing here.
Context: ...t in Figure 2. (figure-1)= :::{card} ```sql ctx: "conn11" AND msg:...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~134-~134: Did you mean “I”?
Context: ...results for your query. 4. Clicking the icon reveals ad...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~139-~139: Did you mean “I”?
Context: ...ase of your query. 5. Clicking the icon reveals opt...
(I_LOWERCASE_PREMIUM)
[uncategorized] ~140-~140: Did you mean “I”?
Context: ... options for displaying results. 6. The icon clears th...
(I_LOWERCASE_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/src/user-guide/quick-start/clp-text.md
63-63: Link fragments should be valid
(MD051, link-fragments)
63-63: Link fragments should be valid
(MD051, link-fragments)
93-93: Link fragments should be valid
(MD051, link-fragments)
115-115: Inline HTML
Element: i
(MD033, no-inline-html)
120-120: Inline HTML
Element: i
(MD033, no-inline-html)
121-121: Inline HTML
Element: i
(MD033, no-inline-html)
docs/src/user-guide/quick-start/clp-json.md
63-63: Link fragments should be valid
(MD051, link-fragments)
63-63: Link fragments should be valid
(MD051, link-fragments)
93-93: Link fragments should be valid
(MD051, link-fragments)
115-115: Inline HTML
Element: i
(MD033, no-inline-html)
120-120: Inline HTML
Element: i
(MD033, no-inline-html)
121-121: Inline HTML
Element: i
(MD033, no-inline-html)
🔇 Additional comments (1)
docs/src/user-guide/quick-start/clp-json.md (1)
48-48: No change needed:#clp-jsonanchor is validA heading generates the
clp-jsonanchor automatically in the target file:
- File:
docs/src/user-guide/quick-start/index.md
Line 60:### clp-jsonThis satisfies MD051, so you can safely ignore the warning.
kirkrodrigues
dismissed
gibber9809’s stale review
gibber9809 is currently unavailable to re-review but I think their change requests have been addressed.
…or clp-json and clp-text. (y-scope#968) Co-authored-by: Devin Gibson <gibber9809@users.noreply.github.com> Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Description
The quick-start section of CLP docs integrated explanations of clp-json and clp-text throughout, and it was split up into multiple pages to be more readable. This PR untangles these sections from one another and puts each on an independent page; in addition, it compiles all quick-start information for each flavour on a single page, rather than multiple pages. This will allow more room for the docs of each flavour to grow, and also make explanation of each flavour more streamlined. In addition, the page on multi-node development which was formerly part of the quick-start guide was moved to "Guides" so as not to complicate the new quick-start flow.
Checklist
breaking change.
Validation performed
Served website to local host, tried every link on every page; no bad links. All workflows passed.
Summary by CodeRabbit