Looks like a promising feature. Thanks Matteo for proposing this feature!
Best regards Alin ________________________________ Från: Tomek CEDRO <to...@cedro.info> Skickat: den 27 april 2025 22:49 Till: dev@nuttx.apache.org <dev@nuttx.apache.org> Ämne: Re: Documentation tags for boards Very cool start Matteo! Builds and works fine for me :-) Would it be possible to rename "Site Tags" to just "Tags"? :-) Thank you :-) Tomek On Sun, Apr 27, 2025 at 8: 51 PM Matteo Golin <matteo. golin@ gmail. com> wrote: > > Hello everyone, Very cool start Matteo! Builds and works fine for me :-) Would it be possible to rename "Site Tags" to just "Tags"? :-) Thank you :-) Tomek On Sun, Apr 27, 2025 at 8:51 PM Matteo Golin <matteo.go...@gmail.com> wrote: > > Hello everyone, > > I opened a PR here to test out using tags in our docs: > https://urldefense.com/v3/__https://github.com/apache/nuttx/pull/16275__;!!O7_YSHcmd9jp3hj_4dEAcyQ!00sA-EkxUCT6wXreo3756CstdLTmsW8DwB-Ub33S5y5UxSQfCeeWnR5Pz1hZmWN-tnkfO-ER5Ku9AxAOOw$ > Please leave your feedback! > > For now, I've included three types of tags: > - Chip tags to indicate what chip a board uses > - Peripheral tags to indicate supported peripherals (WiFi, Ethernet, etc) > - 'Experimental' tag to indicate experimentally supported boards and > drivers that are still under testing. This should hopefully alleviate some > issues when it's adopted so users can avoid using experimental boards if > they need a stable system. > > Let me know what you think or if you have any tag ideas! I'm considering > having architecture tags like it was suggested here, and maybe also adding > some feature tags that aren't necessarily related to peripherals like > "multicore", "SMP", "asymmetric cores", "graphics" (for graphics capable > systems), etc. I also think it might be a good idea to add "stable" tags to > boards which are regularly tested, but that might have to wait until we're > able to really commit to maintaining the stability of those boards. > > If this gets accepted I can work on tagging more of the documentation. > > Matteo > > On Thu, Apr 17, 2025 at 6:12 PM Matteo Golin <matteo.go...@gmail.com> wrote: > > > Actually, I was just thinking about supported peripherals/features when I > > thought about this, but I also think having tags for MCUs/chips would be > > really useful! Perhaps even architectures, although I'm not sure if that's > > necessary since all the boards are organized into directories based on > > architecture anyways. I don't think every board needs its own tag since > > each board is unique, it can just be searched by name. > > > > Happy to see that other people would benefit from this feature! > > > > Matteo > > > > On Thu, Apr 17, 2025 at 1:49 PM Tomek CEDRO <to...@cedro.info> wrote: > > > >> Hi Matteo! Very cool idea to have tags in the docs to mark supported > >> features! :-) > >> > >> I would see a list of all available predefined tags somewhere at the > >> end of documentation (tag index) so we know what is out there and not > >> to create new ones, so the search results and markings are coherent. > >> > >> Each board could have its own tag, mcu would have its own mcu, and > >> supported peripherals (i.e. wifi), right? > >> > >> Thanks :-) > >> Tomek > >> > >> > >> > >> On Thu, Apr 17, 2025 at 2:49 AM Matteo Golin <matteo.go...@gmail.com> > >> wrote: > >> > > >> > Hello everyone, > >> > > >> > I am starting a new drone project which I am hoping to use NuttX for, > >> and as part of the project I am looking for NuttX > >> > supported boards that include WiFi support. I was thinking, it might be > >> useful for the NuttX documentation to make use > >> > of a tag system to easily search for features. > >> > > >> > I found this Sphinx extension that allows you to use tags, maybe we > >> could start using it in NuttX's docs: > >> > https://urldefense.com/v3/__https://sphinx-tags.readthedocs.io/en/latest/quickstart.html*usage__;Iw!!O7_YSHcmd9jp3hj_4dEAcyQ!00sA-EkxUCT6wXreo3756CstdLTmsW8DwB-Ub33S5y5UxSQfCeeWnR5Pz1hZmWN-tnkfO-ER5KtBke7GJA$ > >> > > >> > This way it would be possible to filter boards by different features, > >> which would be a useful search feature. For > >> > example, the XIAO ESP32S3 has hardware support for WiFi: > >> > > >> https://urldefense.com/v3/__https://nuttx.apache.org/docs/latest/platforms/xtensa/esp32s3/boards/esp32s3-xiao/index.html__;!!O7_YSHcmd9jp3hj_4dEAcyQ!00sA-EkxUCT6wXreo3756CstdLTmsW8DwB-Ub33S5y5UxSQfCeeWnR5Pz1hZmWN-tnkfO-ER5Kv8hFWKGA$ > >> > > >> > But I don't think NuttX implements it yet. If I were able to filter by > >> boards that support WiFi, I wouldn't have to look > >> > up supported boards I'm not familiar with, or read all their > >> documentation pages. I wanted to know what others think; > >> > would this would be worthwhile to add or is it just more work to ensure > >> that documented boards include the proper tags? > >> > > >> > On a side note, if there is anyone who has written WiFi support for a > >> chip in NuttX, please let me know if you have any > >> > tips to get started or if you've happened to write a guide. I might > >> decide to spend some time on adding support for > >> > wireless chips to learn more about it. > >> > > >> > Thanks! > >> > > >> > -- > >> > Matteo Golin > >> > >> > >> > >> -- > >> CeDeROM, SQ7MHZ, > >> https://urldefense.com/v3/__http://www.tomek.cedro.info__;!!O7_YSHcmd9jp3hj_4dEAcyQ!00sA-EkxUCT6wXreo3756CstdLTmsW8DwB-Ub33S5y5UxSQfCeeWnR5Pz1hZmWN-tnkfO-ER5KtjSb4KNQ$ > >> > > -- CeDeROM, SQ7MHZ, https://urldefense.com/v3/__http://www.tomek.cedro.info__;!!O7_YSHcmd9jp3hj_4dEAcyQ!00sA-EkxUCT6wXreo3756CstdLTmsW8DwB-Ub33S5y5UxSQfCeeWnR5Pz1hZmWN-tnkfO-ER5KtjSb4KNQ$
