Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rename hello_rust to rust/baremetal to reflect the actual codebase #15711

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

no1wudi
Copy link
Contributor

@no1wudi no1wudi commented Jan 29, 2025

Summary

  • The hello_rust example has been moved to rust/baremetal to better reflect its purpose as a bare-metal Rust application.
  • The move also helps in organizing the Rust examples more clearly, separating them into categories based on their environment (bare-metal vs. non-bare-metal).
  • A new directory structure has been created under rust/baremetal, and the index.rst file has been updated to describe the baremetal example in detail.
  • The top-level rust/index.rst file has been created to include the new rust/baremetal directory in the toctree.

Impact

  • The new file structure and documentation improvements will help new contributors and users understand the purpose and setup of the example more easily.
  • This change aligns the documentation with the actual codebase, enhancing the overall maintainability and clarity of the project.

Testing

GitHub CI and local document build

Summary:
- The `hello_rust` example has been moved to `rust/baremetal` to better reflect its purpose as a bare-metal Rust application.
- The move also helps in organizing the Rust examples more clearly, separating them into categories based on their environment (bare-metal vs. non-bare-metal).
- A new directory structure has been created under `rust/baremetal`, and the `index.rst` file has been updated to describe the `baremetal` example in detail.
- The top-level `rust/index.rst` file has been created to include the new `rust/baremetal` directory in the toctree.

Impact:
- The new file structure and documentation improvements will help new contributors and users understand the purpose and setup of the example more easily.
- This change aligns the documentation with the actual codebase, enhancing the overall maintainability and clarity of the project.

Signed-off-by: Huang Qi <[email protected]>
@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Jan 29, 2025
@xiaoxiang781216 xiaoxiang781216 merged commit 68d1750 into apache:master Jan 29, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants