Skip to content

Conversation

Nithinnithu0610
Copy link

This PR adds a new Markdown file under doc/architecture/ that documents the Zephyr technical architecture.

  • Provides high-level system overview
  • Helps contributors and users understand the project structure
  • Complements existing developer documentation

Copy link

Hello @Nithinnithu0610, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

@Nithinnithu0610
Copy link
Author

Hello Maintainers,

I have added a new architecture documentation file (doc/architecture/zephyr_architecture_Diagram.md) as part of my contribution.
This document provides a high-level overview of Zephyr’s architecture for easier understanding and future reference.

Kindly review this PR and let me know if any improvements or changes are required.

Thank you for your time and guidance! 🙏

— Nithin H (GitHub: @Nithinnithu0610)

@pdgendt
Copy link
Contributor

pdgendt commented Sep 19, 2025

I don't think this should live alongside the existing documentation. Also feels 🤖-generated...

Copy link

@kartben
Copy link
Contributor

kartben commented Sep 20, 2025

@Nithinnithu0610 thanks for the contribution. Given we use neither mermaid (but might one day) nor Markdown we can't really accept this PR.

I don't necessarily mind you using an LLM to look at ways to improve our docs but I would suggest your work towards incrementally improving our existing doc pages.

I'll probably close this PR in a few days unless you want to update it with changes more align with our current doc style and doc infrastructure. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants