docs: Rename "user/developer guide" to "user/developer docs" to differentiate them from the guides they contain. - #1155
Conversation
…ev-docs' respectively; modify all references to these directories
WalkthroughDocumentation links and headings across READMEs and markdown docs were updated to replace "dev-guide"/"user-guide" with "dev-docs"/"user-docs" and minor wording/formatting tweaks; a few in-code documentation comment paths were updated similarly. No code logic or public APIs were changed. Changes
Sequence Diagram(s)No sequence diagrams (documentation-only changes). Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageTooldocs/src/dev-docs/index.md[uncategorized] ~3-~3: Did you mean “I”? (I_LOWERCASE_PREMIUM) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
🔇 Additional comments (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/src/user-docs/quick-start/clp-json-search-ui.pngis excluded by!**/*.pngdocs/src/user-docs/quick-start/clp-text-search-ui.pngis excluded by!**/*.png
📒 Files selected for processing (9)
README.md(1 hunks)components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py(1 hunks)components/core/README.md(1 hunks)components/core/src/clp/ffi/search/CompositeWildcardToken.cpp(1 hunks)components/core/src/glt/ffi/search/CompositeWildcardToken.cpp(1 hunks)components/package-template/src/README.md(1 hunks)components/webui/README.md(1 hunks)docs/src/dev-docs/design-kv-ir-streams/background.md(2 hunks)docs/src/index.md(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}
⚙️ CodeRabbit Configuration File
- Prefer
false == <expression>rather than!<expression>.
Files:
components/core/src/clp/ffi/search/CompositeWildcardToken.cppcomponents/core/src/glt/ffi/search/CompositeWildcardToken.cpp
🧠 Learnings (20)
📓 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.
📚 Learning: the function `trivial_new_projected_schema_tree_node_callback` in the kv-ir codebase is properly doc...
Learnt from: LinZhihao-723
PR: y-scope/clp#873
File: components/core/src/clp/ffi/ir_stream/search/test/utils.cpp:78-84
Timestamp: 2025-05-02T23:49:30.798Z
Learning: The function `trivial_new_projected_schema_tree_node_callback` in the KV-IR codebase is properly documented in the header file to indicate its purpose for testing, which addresses static analyzer warnings about unused functions.
Applied to files:
components/core/src/clp/ffi/search/CompositeWildcardToken.cppcomponents/core/src/glt/ffi/search/CompositeWildcardToken.cpp
📚 Learning: the function `trivial_new_projected_schema_tree_node_callback` in the kv-ir codebase is documented i...
Learnt from: LinZhihao-723
PR: y-scope/clp#873
File: components/core/src/clp/ffi/ir_stream/search/test/utils.cpp:78-84
Timestamp: 2025-05-02T23:49:30.798Z
Learning: The function `trivial_new_projected_schema_tree_node_callback` in the KV-IR codebase is documented in the header file to explain its purpose for testing, which addresses static analyzer warnings about unused functions.
Applied to files:
components/core/src/clp/ffi/search/CompositeWildcardToken.cppcomponents/core/src/glt/ffi/search/CompositeWildcardToken.cpp
📚 Learning: in the clp search component, the `evaluate_wildcard_filter` function should return `astevaluationres...
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.
Applied to files:
components/core/src/clp/ffi/search/CompositeWildcardToken.cpp
📚 Learning: the clp project team has decided to refrain from using include directives in their documentation at ...
Learnt from: quinntaylormitchell
PR: y-scope/clp#1069
File: docs/src/user-guide/quick-start/clp-json.md:135-152
Timestamp: 2025-07-05T03:38:16.779Z
Learning: The CLP project team has decided to refrain from using include directives in their documentation at present, preferring to maintain duplicated content rather than using shared includes or partials for de-duplication.
Applied to files:
components/core/README.mddocs/src/index.md
📚 Learning: in the clp project, antlr code generation at build time is being removed by another pr. when reviewi...
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.
Applied to files:
components/core/README.md
📚 Learning: in clp installation scripts within `components/core/tools/scripts/lib_install/`, maintain consistenc...
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.
Applied to files:
components/core/README.md
📚 Learning: the clp project team prefers to use video content to demonstrate detailed procedural steps (like tar...
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:73-109
Timestamp: 2025-06-18T20:39:05.899Z
Learning: The CLP project team prefers to use video content to demonstrate detailed procedural steps (like tarball extraction) rather than including every step in the written documentation, keeping the docs focused on conceptual guidance.
Applied to files:
components/core/README.mdcomponents/webui/README.mddocs/src/index.mdcomponents/package-template/src/README.mdREADME.mddocs/src/dev-docs/design-kv-ir-streams/background.md
📚 Learning: in `components/log-viewer-webui/client/src/api/query.js`, the `extractjsonresp` type definition is a...
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.
Applied to files:
components/webui/README.md
📚 Learning: the y-scope/clp codebase has a 100-character line length limit that takes precedence over other styl...
Learnt from: junhaoliao
PR: y-scope/clp#1078
File: components/webui/server/src/plugins/MongoSocketIoServer/index.ts:105-108
Timestamp: 2025-07-08T17:20:02.560Z
Learning: The y-scope/clp codebase has a 100-character line length limit that takes precedence over other style preferences like template literals when they conflict.
Applied to files:
components/webui/README.md
📚 Learning: in the current clp codebase implementation, dataset validation using validate_dataset() is performed...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1050
File: components/clp-package-utils/clp_package_utils/scripts/search.py:100-106
Timestamp: 2025-07-03T20:10:43.789Z
Learning: In the current CLP codebase implementation, dataset validation using validate_dataset() is performed within the native scripts (like clp_package_utils/scripts/native/search.py) rather than at the wrapper script level, where the native scripts handle their own parameter validation.
Applied to files:
docs/src/index.md
📚 Learning: in the clp codebase, the validate_and_cache_dataset function in components/clp-py-utils/clp_py_utils...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1036
File: components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py:204-211
Timestamp: 2025-07-03T12:58:18.407Z
Learning: In the CLP codebase, the validate_and_cache_dataset function in components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py uses in-place updates of the existing_datasets set parameter rather than returning a new set, as preferred by the development team.
Applied to files:
docs/src/index.mdcomponents/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py
📚 Learning: clp is designed to run on linux systems where python is typically pre-installed, so python installat...
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.
Applied to files:
docs/src/index.mdcomponents/package-template/src/README.md
📚 Learning: in the clp project, when reviewing cmakelists.txt changes that introduce new compression library dep...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1122
File: components/core/src/clp/clp/CMakeLists.txt:175-195
Timestamp: 2025-07-23T09:54:45.185Z
Learning: In the CLP project, when reviewing CMakeLists.txt changes that introduce new compression library dependencies (BZip2, LibLZMA, LZ4, ZLIB), the team prefers to address conditional linking improvements in separate PRs rather than expanding the scope of focused migration PRs like the LibArchive task-based installation migration.
Applied to files:
docs/src/index.mdcomponents/package-template/src/README.mdREADME.mddocs/src/dev-docs/design-kv-ir-streams/background.md
📚 Learning: in the clp codebase, the get_orig_file_id function signature was changed after a recent merge to no ...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1004
File: components/clp-package-utils/clp_package_utils/scripts/native/decompress.py:139-144
Timestamp: 2025-06-24T08:54:14.438Z
Learning: In the CLP codebase, the get_orig_file_id function signature was changed after a recent merge to no longer accept a dataset parameter, making previous suggestions that reference this parameter invalid.
Applied to files:
docs/src/index.mdcomponents/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py
📚 Learning: in the clp-package compression flow, path validation and error handling is performed at the schedule...
Learnt from: haiqi96
PR: y-scope/clp#651
File: components/clp-package-utils/clp_package_utils/scripts/compress.py:0-0
Timestamp: 2025-01-16T16:58:43.190Z
Learning: In the clp-package compression flow, path validation and error handling is performed at the scheduler level rather than in the compress.py script to maintain simplicity and avoid code duplication.
Applied to files:
components/package-template/src/README.mddocs/src/dev-docs/design-kv-ir-streams/background.md
📚 Learning: in the clp project, the .clang-format file is maintained in the yscope-dev-utils submodule and copie...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1126
File: .gitignore:5-5
Timestamp: 2025-07-25T21:29:48.947Z
Learning: In the CLP project, the .clang-format file is maintained in the yscope-dev-utils submodule and copied over to the main CLP repository, so it should be ignored in .gitignore to prevent accidental commits of the copied file and maintain the single source of truth in the submodule.
Applied to files:
README.md
📚 Learning: in clp-s documentation, technical abbreviations like "mpt" (merged parse tree) should be defined at ...
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.
Applied to files:
docs/src/dev-docs/design-kv-ir-streams/background.md
📚 Learning: in `clp-s.cpp`, the `run_serializer` function interleaves serialization and writing of ir files, mak...
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.
Applied to files:
docs/src/dev-docs/design-kv-ir-streams/background.md
📚 Learning: the column metadata table (created by `_create_column_metadata_table`) is only needed for dataset-sp...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#868
File: components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py:141-144
Timestamp: 2025-05-05T16:32:55.163Z
Learning: The column metadata table (created by `_create_column_metadata_table`) is only needed for dataset-specific workflows in `CLP_S` and is obsolete for non-dataset workflows.
Applied to files:
components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py
🪛 markdownlint-cli2 (0.17.2)
README.md
108-108: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
docs/src/dev-docs/design-kv-ir-streams/background.md
321-321: Line length
Expected: 80; Actual: 90
(MD013, line-length)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-macos (macos-15, false)
- GitHub Check: build-macos (macos-15, true)
🔇 Additional comments (12)
components/core/src/glt/ffi/search/CompositeWildcardToken.cpp (1)
141-143: Documentation path updated correctlyThe reference now correctly points to
dev-docs, matching the new directory naming convention. No further action required.components/core/README.md (1)
7-8: Links realigned with new docs hierarchyBoth links adopt the
dev-docs/user-docsscheme, keeping external references consistent.components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py (1)
135-137: Comment link modernisedThe design doc path now reflects
dev-docs, maintaining link validity.docs/src/dev-docs/design-kv-ir-streams/background.md (2)
14-15: Anchor updated to user-docsThe clp-s link now complies with the renamed
user-docsdirectory.
321-323: Long line flagged by markdownlintLine 321 exceeds the 80-column guideline (MD013). Consider wrapping if you wish to silence the linter; otherwise safe to ignore, as this PR scope is link-renaming.
⛔ Skipped due to learnings
Learnt from: junhaoliao PR: y-scope/clp#1078 File: components/webui/server/src/plugins/MongoSocketIoServer/index.ts:105-108 Timestamp: 2025-07-08T17:20:02.560Z Learning: The y-scope/clp codebase has a 100-character line length limit that takes precedence over other style preferences like template literals when they conflict.Learnt from: haiqi96 PR: y-scope/clp#523 File: components/core/src/clp/clp/FileCompressor.hpp:58-78 Timestamp: 2024-10-24T14:25:17.978Z Learning: When reviewing legacy code refactors, avoid suggesting changes that would extend the scope of the PR.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: 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: 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: quinntaylormitchell PR: y-scope/clp#1069 File: docs/src/user-guide/quick-start/clp-json.md:135-152 Timestamp: 2025-07-05T03:38:16.779Z Learning: The CLP project team has decided to refrain from using include directives in their documentation at present, preferring to maintain duplicated content rather than using shared includes or partials for de-duplication.components/webui/README.md (1)
7-7: Docs link adjustedURL now targets
dev-docs, matching project-wide rename.README.md (1)
102-111: Updated doc links look correctAll four references have been switched to the new
dev-docs/user-docspaths and resolve properly when tested locally.components/core/src/clp/ffi/search/CompositeWildcardToken.cpp (1)
140-144: Comment path updated – LGTMThe reference is now under
dev-docs, matching the new directory structure. No code logic touched.components/package-template/src/README.md (1)
7-9: Link path updated correctlyThe quick-start URL now points at
user-docs/quick-start-overview; resolves fine.docs/src/index.md (3)
80-92: Card links migrated to new docs sections
user-docs/indexanddev-docs/indexlook good and render as expected when building the docs.
110-112: TOC paths updated – LGTMHidden toctree entries now reference the renamed folders; no further action needed.
121-121: Datasets link kept in syncRelative link updated to
user-docs/resources-datasets; works correctly.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 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.
📚 Learning: the clp project team prefers to use video content to demonstrate detailed procedural steps (like tar...
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:73-109
Timestamp: 2025-06-18T20:39:05.899Z
Learning: The CLP project team prefers to use video content to demonstrate detailed procedural steps (like tarball extraction) rather than including every step in the written documentation, keeping the docs focused on conceptual guidance.
Applied to files:
README.md
📚 Learning: in the clp project, when reviewing cmakelists.txt changes that introduce new compression library dep...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1122
File: components/core/src/clp/clp/CMakeLists.txt:175-195
Timestamp: 2025-07-23T09:54:45.185Z
Learning: In the CLP project, when reviewing CMakeLists.txt changes that introduce new compression library dependencies (BZip2, LibLZMA, LZ4, ZLIB), the team prefers to address conditional linking improvements in separate PRs rather than expanding the scope of focused migration PRs like the LibArchive task-based installation migration.
Applied to files:
README.md
📚 Learning: in the clp project, the .clang-format file is maintained in the yscope-dev-utils submodule and copie...
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1126
File: .gitignore:5-5
Timestamp: 2025-07-25T21:29:48.947Z
Learning: In the CLP project, the .clang-format file is maintained in the yscope-dev-utils submodule and copied over to the main CLP repository, so it should be ignored in .gitignore to prevent accidental commits of the copied file and maintain the single source of truth in the submodule.
Applied to files:
README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: centos-stream-9-static-linked-bins
- GitHub Check: ubuntu-jammy-dynamic-linked-bins
- GitHub Check: ubuntu-jammy-lint
- GitHub Check: ubuntu-jammy-static-linked-bins
- GitHub Check: centos-stream-9-dynamic-linked-bins
🔇 Additional comments (1)
README.md (1)
108-108: Trailing-space issue resolved – looks goodThe stray space after the OSDI ’24 paper link is gone, clearing the markdownlint MD009 warning. 👍
|
@quinntaylormitchell I believe we also need to update clp/.github/PULL_REQUEST_TEMPLATE.md Line 37 in 4fa8a55 Otherwise the PR lgtm. Let's rebase and resume the review |
@junhaoliao that instance of I will rebase and let you know when it's ready for another review. |
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/src/user-docs/index.md (1)
15-16: Standardize spelling: “flavour” vs “flavor”.Elsewhere (e.g., user-docs/core-overview.md Line 6) you use “flavours” (Canadian/British). Here it’s “flavor” (US). Pick one and apply consistently; given the project already uses “flavours” in adjacent pages, consider switching this instance.
Apply this diff:
-A quick-start guide for choosing a flavor of CLP, setting it up, compressing your logs, and +A quick-start guide for choosing a flavour of CLP, setting it up, compressing your logs, and
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
docs/src/dev-docs/index.md(1 hunks)docs/src/index.md(3 hunks)docs/src/user-docs/core-overview.md(1 hunks)docs/src/user-docs/index.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-06-18T20:39:05.899Z
Learnt from: quinntaylormitchell
PR: y-scope/clp#968
File: docs/src/user-guide/quick-start/overview.md:73-109
Timestamp: 2025-06-18T20:39:05.899Z
Learning: The CLP project team prefers to use video content to demonstrate detailed procedural steps (like tarball extraction) rather than including every step in the written documentation, keeping the docs focused on conceptual guidance.
Applied to files:
docs/src/user-docs/core-overview.md
🪛 LanguageTool
docs/src/dev-docs/index.md
[uncategorized] ~3-~3: Did you mean “I”?
Context: ...left sidebar (if it's hidden, click the icon) to naviga...
(I_LOWERCASE_PREMIUM)
docs/src/user-docs/index.md
[uncategorized] ~3-~3: Did you mean “I”?
Context: ...left sidebar (if it's hidden, click the icon) to naviga...
(I_LOWERCASE_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: build-macos (macos-15, true)
- GitHub Check: build-macos (macos-15, false)
- GitHub Check: ubuntu-jammy-static-linked-bins
- GitHub Check: ubuntu-jammy-dynamic-linked-bins
- GitHub Check: ubuntu-jammy-lint
- GitHub Check: centos-stream-9-static-linked-bins
- GitHub Check: centos-stream-9-dynamic-linked-bins
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (9)
docs/src/user-docs/core-overview.md (1)
6-7: Wording aligns with the rename and reads clearly.The sentence is concise and accurately sets context for the two flavours. No issues found.
docs/src/dev-docs/index.md (1)
1-1: Header rename is correct and consistent with the new “dev-docs” taxonomy.This matches the site-wide convention shift from “guide” to “docs”.
docs/src/user-docs/index.md (1)
1-1: Header rename looks good and matches the new “user-docs” taxonomy.Consistent with changes across the docs site.
docs/src/index.md (6)
74-74: Good rewording.“docs below” clarifies the taxonomy change without altering intent.
80-81: Link target and label updated correctly (user-docs).Matches the new directory layout.
87-88: Link target and label updated correctly (dev-docs).Consistent with the developer section rename.
110-111: Toctree entries updated correctly to new roots.This should keep the landing cards and sidebar in sync.
121-121: Link reference verified and resolving correctly
All targeted files for the[datasets]link are present underdocs/src/user-docs/resources-datasets.mdand related index pages. No broken links detected.
74-121: All non-intentional “user-guide”/“dev-guide” references removedThe grep scan only returned the expected external link to the Y-Scope contributor guidelines (
https://docs.yscope.com/dev-guide/contrib-guides-overview.html), which we agreed to keep. No other stray “user-guide” or “dev-guide” identifiers remain in the repo.
junhaoliao
left a comment
junhaoliao
left a comment
There was a problem hiding this comment.
lgtm. i verified that:
- there's no broken link
- global search of
user-guideanddev-guidedo not show any results related to the docs in repoy-scope/clp task docs:sitedoes not show any error / warning- The text references (e.g., in the header) have been updated as "User docs" / "Developer docs"; global search of
User docsandDeveloper docsdo not show any results related to the docs in repoy-scope/clp
if i understand correctly, it's important to update the links first, so the other repos can use the updated links. Then categorization of guides / docs is to be done in anther PR. cc @kirkrodrigues for confirmation
for the PR title, how about:
docs: Rename user/developer guides to user/developer docs and update references.
Correct |
quinntaylormitchell
changed the title
user-guide to user-docs and dev-guide to dev-docs
kirkrodrigues
left a comment
kirkrodrigues
left a comment
There was a problem hiding this comment.
For the PR title, how about:
docs: Rename "user/developer guide" to "user/developer docs" to differentiate them from the guides they contain.
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
quinntaylormitchell
changed the title
kirkrodrigues
left a comment
kirkrodrigues
left a comment
There was a problem hiding this comment.
Deferring to @junhaoliao's review.
…ope/clp#1155. (#360) Co-authored-by: Junhao Liao <junhao.liao@yscope.com>
…rentiate them from the guides they contain. (y-scope#1155) Co-authored-by: Junhao Liao <junhao.liao@yscope.com> Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
3 participants
Description
Going forward, we're transitioning to use the word "guide" only in the context of the Guides section in the docs. Within this new context, the
user-guideanddev-guidedirectories inclp/docs/src/are inappropriately named. This PR renames theuser-guideanddev-guidedirectories touser-docsanddev-docsrespectively. All references to these directories in the codebase are updated accordingly.Note: there are five other small PRs in other
y-scope/repos that depend on this PR. They are linked in the comments.Checklist
breaking change.
Validation performed
Built and served the docs; tried all new links.
Summary by CodeRabbit