doc: Add architeucture document in developer guide. - #162
Closed
sitaowang1998 wants to merge 7 commits into
Closed
Conversation
Contributor
|
Caution Review failedThe pull request is closed. WalkthroughThe changes update the integration of the ystdlib-cpp dependency from a local subdirectory build to a CMake-installed package using find_package. Dependency installation tasks are refactored for consistency and CMake-centric workflows. New documentation on system architecture is added, and scripts for precise CMake installation are introduced and updated. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant install-dev.sh
participant install-cmake.sh
participant System
Developer->>install-dev.sh: Run script
install-dev.sh->>install-cmake.sh: Call with version 3.23.5
install-cmake.sh->>System: Download, build, and install CMake 3.23.5
install-cmake.sh-->>install-dev.sh: Return control
install-dev.sh->>System: Run check-cmake-version.sh
sequenceDiagram
participant BuildSystem
participant CMakeLists.txt
participant ystdlib (as Installed Package)
BuildSystem->>CMakeLists.txt: Configure project
CMakeLists.txt->>ystdlib: find_package(ystdlib REQUIRED)
ystdlib-->>CMakeLists.txt: Provide version and targets
CMakeLists.txt-->>BuildSystem: Status message and continue build
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (6)
✨ Finishing Touches
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. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
As title.
Checklist
breaking change.
Validation performed
task docs:sitebuilds successfully and local website fromtask docs:servelooks as expected.Summary by CodeRabbit
New Features
Chores
Documentation