docs(core): Remove obsolete references to submodules; Reformat list of libraries into a table. by quinntaylormitchell · Pull Request #940 · y-scope/clp

quinntaylormitchell · 2025-05-29T15:29:11Z

Description

Omits references to git submodules in one docs file to comply with PR #858, and formats the list of dependencies used by core into a table.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

N/A

Summary by CodeRabbit

Documentation
- Improved the clarity and detail of the core component's dependency documentation by switching to a structured table format, updating library names, and refining descriptions.
- Updated introductory text to clarify that dependencies are downloaded, built, and installed, enhancing overall readability and precision.

…omply with PR y-scope#858

coderabbitai · 2025-05-29T15:29:17Z

Walkthrough

The documentation for core component source dependencies was updated. A simple bullet list was replaced with a structured table detailing each dependency, its version or commit, and relevant notes. The introductory text now clarifies that the task deps:core command downloads, builds, and installs these dependencies.

Changes

File(s)	Change Summary
docs/src/dev-guide/components-core/index.md	Replaced bullet list of dependencies with a detailed table; updated intro text for clarity.

Sequence Diagram(s)

No sequence diagram is provided as the changes are limited to documentation structure and content.

Possibly related PRs

docs(core): Update dependency versions in CLP-core developer guide. #771: Updates documentation for core component dependencies, restructuring the list into a detailed table and updating versions.
chore(core): Add ystdlib-cpp library as a submodule. #730: Adds the ystdlib-cpp library as a new submodule and integrates it into the build system; relates to the documentation update reflecting this dependency.

Suggested reviewers

davidlion

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9759b14 and a709e96.

📒 Files selected for processing (1)

docs/src/dev-guide/components-core/index.md (1 hunks)

🔇 Additional comments (2)

docs/src/dev-guide/components-core/index.md (2)

34-37: Structured table enhances clarity
The new table format clearly outlines each dependency, version, and notes, making it more readable and maintainable than a simple bullet list.

38-52: Verify renamed dependency identifiers
Ensure that the table’s library names (e.g., absl, nlohmann_json, ystdlib) accurately reflect the CMake targets or package names used in your build and import scripts to prevent any mismatches.

kirkrodrigues

For the PR title, how about:

docs(core): Remove obsolete references to submodules; Reformat list of libraries into a table.

…include links with library names

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a709e96 and 0533405.

📒 Files selected for processing (1)

docs/src/dev-guide/components-core/index.md (1 hunks)

🔇 Additional comments (2)

docs/src/dev-guide/components-core/index.md (2)

28-28: Well-phrased directive
The new phrasing uses a clear infinitive structure to introduce the command, which aligns with previous suggestions and provides a direct instruction.

34-34: Concise task description
The sentence clearly explains what the deps:core task does—downloading, building, and installing—which matches the intended behaviour.

Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (2)

docs/src/dev-guide/components-core/index.md (2)
28-28: 🧹 Nitpick (assertive)

Use an imperative tone for the task instruction
Improves clarity by giving a direct command.
-To get all dependencies required by CLP core, run the `deps:core` task:
+Run `task deps:core` to download, build, and install all required CLP core dependencies:
38-52: 🛠️ Refactor suggestion

Align library names with PR #858 renames
The table still uses the old package names. Please update to the renamed packages for consistency:

abseil-cpp → absl

json → nlohmann_json

ystdlib-cpp → ystdlib
-| [abseil-cpp](https://github.com/abseil/abseil-cpp)                    | 20230802.1     |
-| [json](https://github.com/nlohmann/json.git)                          | v3.11.3        |
-| [ystdlib-cpp](https://github.com/y-scope/ystdlib-cpp.git)             | 2ac1757        |
+| [absl](https://github.com/abseil/abseil-cpp)                           | 20230802.1     |
+| [nlohmann_json](https://github.com/nlohmann/json.git)                  | v3.11.3        |
+| [ystdlib](https://github.com/y-scope/ystdlib-cpp.git)                  | 2ac1757        |

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0533405 and b900da8.

📒 Files selected for processing (1)

docs/src/dev-guide/components-core/index.md (1 hunks)

kirkrodrigues · 2025-05-29T20:09:46Z

Can you update the PR description to reflect the latest changes?

…f libraries into a table. (y-scope#940) Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>

reworded section that mentioned git submodules and updated names to c…

a709e96

…omply with PR y-scope#858

quinntaylormitchell requested a review from a team as a code owner May 29, 2025 15:29

coderabbitai Bot reviewed May 29, 2025

View reviewed changes

Comment thread docs/src/dev-guide/components-core/index.md Outdated

kirkrodrigues requested changes May 29, 2025

View reviewed changes

Comment thread docs/src/dev-guide/components-core/index.md Outdated

Comment thread docs/src/dev-guide/components-core/index.md Outdated

Comment thread docs/src/dev-guide/components-core/index.md Outdated

quinntaylormitchell changed the title ~~docs: Omit reference to "submodules" in docs~~ docs(core): Remove obsolete references to submodules; Reformat list of libraries into a table. May 29, 2025

Change formatting and wording to be more precise; omit Notes column; …

0533405

…include links with library names

coderabbitai Bot reviewed May 29, 2025

View reviewed changes

Comment thread docs/src/dev-guide/components-core/index.md Outdated

quinntaylormitchell requested a review from kirkrodrigues May 29, 2025 19:49

kirkrodrigues requested changes May 29, 2025

View reviewed changes

Comment thread docs/src/dev-guide/components-core/index.md Outdated

Comment thread docs/src/dev-guide/components-core/index.md Outdated

quinntaylormitchell and others added 2 commits May 29, 2025 16:02

Update docs/src/dev-guide/components-core/index.md

1853de0

Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>

Update docs/src/dev-guide/components-core/index.md

b900da8

Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>

quinntaylormitchell requested a review from kirkrodrigues May 29, 2025 20:03

coderabbitai Bot reviewed May 29, 2025

View reviewed changes

Comment thread docs/src/dev-guide/components-core/index.md

kirkrodrigues approved these changes May 29, 2025

View reviewed changes

Merge branch 'main' into submodule-erasure

0077801

kirkrodrigues merged commit 05e3587 into y-scope:main May 29, 2025
5 checks passed

This was referenced Jun 8, 2025

build(deps): Migrate mongocxx dependencies to task-based installation (resolves #979). #980

Merged

build(deps-core): Bump abseil version from 20230802.1 to 20250512.0. #985

Merged

coderabbitai Bot mentioned this pull request Aug 6, 2025

build(deps): Add task-based installations for LZ4 and Zstandard dependencies; Use latest versions for source-based installations. #1156

Merged

4 tasks

coderabbitai Bot mentioned this pull request Aug 25, 2025

docs(clp-core): Update CLP core dependency names and versions. #1262

Merged

4 tasks

Conversation

quinntaylormitchell commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kirkrodrigues left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kirkrodrigues commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

quinntaylormitchell commented May 29, 2025 •

edited

Loading

coderabbitai Bot commented May 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

kirkrodrigues commented May 29, 2025 •

edited

Loading