[ISSUE #2461]📝Add Architecture doc💫

[mxsm]

Which Issue(s) This PR Fixes(Closes)

Fixes #2461

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

• Documentation

  • Restructured documentation navigation
  • Added new "Architecture" documentation section
  • Updated "Quick Start Guide" title and navigation
  • Modified home page button and release text

• Style

  • Removed image width and height attributes on home page

[coderabbitai]

Walkthrough

This pull request focuses on enhancing the documentation structure for the RocketMQ Rust project. The changes include updating the navigation configuration, adding a new architecture documentation page, and making minor modifications to the home page. The navigation has been reorganized to highlight the architecture and quick start guide, with a new 01-architecture.md document introduced to provide insights into the project's architectural overview.

Changes

File	Change Summary
_data/navigation.yml	- Updated "Docs" URL from /docs/quick-start-guide/ to /docs/architecture/ - Added "Quick Start Guide" under "Getting Started" - Added new "Architecture" section
_docs/01-architecture.md	- New documentation file created - Permalink set to /docs/architecture/ - Marked as work in progress (WIP)
_docs/02-quick-start-guide.md	- Renamed "Quick-Start Guide" to "Quick Start Guide"
_pages/home.md	- Changed Quick Start button icon - Updated release text with bookmark emoji - Removed image width/height attributes

Assessment against linked issues

Objective	Addressed	Explanation
Add Architecture Documentation [#2461]	✅

Possibly related PRs

• [ISSUE #2440]Add algolia support #2441: Configuration changes in _config.yml related to navigation settings
• [ISSUE #2444]⚡️Update algolia index #2445: Additional modifications to _config.yml
• [ISSUE #2446]📝Add Contributor Guide doc #2447: Addition of "Contribute Guide" documentation

Suggested Labels

documentation📝, approved, auto merge, AI review first

Suggested Reviewers

• TeslaRustor
• SpaceXCN
• rocketmq-rust-bot

Poem

🚀 Docs take flight, navigation bright
Architecture unveiled, knowledge ignite
Quick start guide, a rabbit's delight
RocketMQ Rust, soaring with might
Documentation's path, now crystal clear
Hop along, engineers, the journey's here! 🐰

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f0b955 and 91c64bb.

📒 Files selected for processing (4)

• rocketmq-doc/_data/navigation.yml (3 hunks)
• rocketmq-doc/_docs/01-architecture.md (1 hunks)
• rocketmq-doc/_docs/02-quick-start-guide.md (1 hunks)
• rocketmq-doc/_pages/home.md (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• rocketmq-doc/_docs/02-quick-start-guide.md
• rocketmq-doc/_docs/01-architecture.md

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: build (windows-latest, nightly)
• GitHub Check: build (windows-latest, stable)
• GitHub Check: build (macos-latest, nightly)
• GitHub Check: build (macos-latest, stable)
• GitHub Check: build (ubuntu-latest, nightly)
• GitHub Check: test
• GitHub Check: build
• GitHub Check: build (ubuntu-latest, stable)
• GitHub Check: auto-approve

🔇 Additional comments (5)

rocketmq-doc/_pages/home.md (2)

9-9: Quick Start Button Icon Updated
The Quick Start button now uses <i class='fa fa-rocket'></i> instead of the previous download icon, which aligns with the refreshed visual design. Please ensure that the correct version of Font Awesome is loaded to support the fa classes.

---

13-13: Enhanced Release Version Display
The release link now integrates a bookmark emoji ("🔖") before the version number. This subtle enhancement draws attention to the release information and improves the page's visual appeal.

rocketmq-doc/_data/navigation.yml (3)

24-24: Updated Main "Docs" Link Target
The main "Docs" link now points to /docs/architecture/ to emphasize the new architecture documentation. Verify that this redirection meets the overall navigation strategy since users might typically expect "Docs" to lead to an index or landing page covering all documentation topics.

---

48-50: Added "Quick Start Guide" Under Getting Started
The inclusion of the "Quick Start Guide" entry with URL /docs/quick-start-guide/ under the "Getting Started" section is a clear improvement that facilitates easy navigation for new users.

---

62-64: Introduced Architecture Section in Navigation
The new Architecture entry under the "Architecture" section (with URL /docs/architecture/) properly highlights the newly added architecture document. Please verify that it links correctly to the intended document (likely _docs/01-architecture.md).

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

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.

[rocketmq-rust-bot]

🔊@mxsm 🚀Thanks for your contribution🎉！

💡CodeRabbit(AI) will review your code first🔥！

Note

🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.62%. Comparing base (9f0b955) to head (91c64bb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2462   +/-   ##
=======================================
  Coverage   28.62%   28.62%           
=======================================
  Files         510      510           
  Lines       73518    73518           
=======================================
  Hits        21044    21044           
  Misses      52474    52474           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rocketmq-rust-bot]

LGTM