Skip to content

Commit a32d035

Browse files
kartbenjhedberg
authored andcommitted
doc: README: Rework Resources section
With close to 20 different links, the Resources section was not really easy to navigate, defeating the purpose of providing quick access to information. Reworked the section to break it down into sub sections, and reworded the links to make them self explanatory. Each sub-section has been re-ordered so that most important links appear first. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent a34fd99 commit a32d035

1 file changed

Lines changed: 56 additions & 34 deletions

File tree

README.rst

Lines changed: 56 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -54,37 +54,59 @@ Resources
5454

5555
Here's a quick summary of resources to help you find your way around:
5656

57-
* **Help**: `Asking for Help Tips`_
58-
* **Documentation**: http://docs.zephyrproject.org (`Getting Started Guide`_)
59-
* **Source Code**: https://github.com/zephyrproject-rtos/zephyr is the main
60-
repository; https://elixir.bootlin.com/zephyr/latest/source contains a
61-
searchable index
62-
* **Releases**: https://github.com/zephyrproject-rtos/zephyr/releases
63-
* **Samples and example code**: see `Sample and Demo Code Examples`_
64-
* **Mailing Lists**: users@lists.zephyrproject.org and
65-
devel@lists.zephyrproject.org are the main user and developer mailing lists,
66-
respectively. You can join the developer's list and search its archives at
67-
`Zephyr Development mailing list`_. The other `Zephyr mailing list
68-
subgroups`_ have their own archives and sign-up pages.
69-
* **Chat**: Real-time chat happens in Zephyr's Discord Server. Use
70-
this `Discord Invite`_ to register.
71-
* **Contributing**: see the `Contribution Guide`_
72-
* **Wiki**: `Zephyr GitHub wiki`_
73-
* **Issues**: https://github.com/zephyrproject-rtos/zephyr/issues
74-
* **Security Issues**: Email vulnerabilities@zephyrproject.org to report
75-
security issues; also see our `Security`_ documentation. Security issues are
76-
tracked separately at https://zephyrprojectsec.atlassian.net.
77-
* **Zephyr Project Website**: https://zephyrproject.org
78-
79-
.. _Discord Invite: https://chat.zephyrproject.org
80-
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
81-
.. _Zephyr Documentation: http://docs.zephyrproject.org
82-
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
83-
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/develop/getting_started/index.html
84-
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
85-
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
86-
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
87-
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
88-
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
89-
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
90-
.. _Asking for Help Tips: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
57+
Getting Started
58+
---------------
59+
60+
| 📖 `Zephyr Documentation`_
61+
| 🚀 `Getting Started Guide`_
62+
| 🙋🏽 `Tips when asking for help`_
63+
| 💻 `Code samples`_
64+
65+
Code and Development
66+
--------------------
67+
68+
| 🌐 `Source Code Repository`_
69+
| 📦 `Releases`_
70+
| 🤝 `Contribution Guide`_
71+
72+
Community and Support
73+
---------------------
74+
75+
| 💬 `Discord Server`_ for real-time community discussions
76+
| 📧 `User mailing list (users@lists.zephyrproject.org)`_
77+
| 📧 `Developer mailing list (devel@lists.zephyrproject.org)`_
78+
| 📬 `Other project mailing lists`_
79+
| 📚 `Project Wiki`_
80+
81+
Issue Tracking and Security
82+
---------------------------
83+
84+
| 🐛 `GitHub Issues`_
85+
| 🔒 `Security documentation`_
86+
| 🛡️ `Security Advisories Repository`_
87+
| ⚠️ Report security vulnerabilities at vulnerabilities@zephyrproject.org
88+
89+
Additional Resources
90+
--------------------
91+
| 🌐 `Zephyr Project Website`_
92+
| 📺 `Zephyr Tech Talks`_
93+
94+
.. _Zephyr Project Website: https://www.zephyrproject.org
95+
.. _Discord Server: https://chat.zephyrproject.org
96+
.. _supported boards: https://docs.zephyrproject.org/latest/boards/index.html
97+
.. _Zephyr Documentation: https://docs.zephyrproject.org
98+
.. _Introduction to Zephyr: https://docs.zephyrproject.org/latest/introduction/index.html
99+
.. _Getting Started Guide: https://docs.zephyrproject.org/latest/develop/getting_started/index.html
100+
.. _Contribution Guide: https://docs.zephyrproject.org/latest/contribute/index.html
101+
.. _Source Code Repository: https://github.com/zephyrproject-rtos/zephyr
102+
.. _GitHub Issues: https://github.com/zephyrproject-rtos/zephyr/issues
103+
.. _Releases: https://github.com/zephyrproject-rtos/zephyr/releases
104+
.. _Project Wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
105+
.. _User mailing list (users@lists.zephyrproject.org): https://lists.zephyrproject.org/g/users
106+
.. _Developer mailing list (devel@lists.zephyrproject.org): https://lists.zephyrproject.org/g/devel
107+
.. _Other project mailing lists: https://lists.zephyrproject.org/g/main/subgroups
108+
.. _Code samples: https://docs.zephyrproject.org/latest/samples/index.html
109+
.. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
110+
.. _Security Advisories Repository: https://github.com/zephyrproject-rtos/zephyr/security
111+
.. _Tips when asking for help: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
112+
.. _Zephyr Tech Talks: https://www.zephyrproject.org/tech-talks

0 commit comments

Comments
 (0)