Is there a way to facilitate both? That is, on the one hand, centralize the documentation in the nuttx repository's Documentation directory so it can be modern and avoid duplication, while at the same time facilitating the terminal usage suggested by Alan?
For example, is it possible to compile the docs to a format such as GNU info (or other suitable terminal-friendly software)? Also, if centralizing it all in Documentation, then is it possible for arch- and board-related docs to have a directory hierarchy that parallels that of the sources? One thing I think needs to always remain true is that the docs should always be in the nuttx repo and *not* move to a separate repo or other kind of CMS. Cheers Nathan On Wed, Jan 18, 2023 at 10:08 PM Brennan Ashton <bash...@brennanashton.com> wrote: > I would like to just move to the documentation section. There is way too > much duplicate out of date common information in the existing readme. The > new documentation has the ability to actually link things. > > Also CI is smart and will only build documentation and not all of the > builds if you make changes in that folder. > > On Wed, Jan 18, 2023, 2:51 PM Alan C. Assis <acas...@gmail.com> wrote: > > > Hi Everyone, > > > > As some have noticed some boards still have their README.txt in their > > original places: > > > > boards/arm/stm32/stm32f4discovery/README.txt > > boards/arm/rp2040/raspberrypi-pico/README.txt > > boards/x86_64/intel64/qemu-intel64/README.txt > > boards/risc-v/qemu-rv/rv-virt/README.txt > > boards/sim/sim/sim/README.txt > > > > While some others moved to the "cloud", I mean: to our website. > > > > I want to suggest a solution to avoid losing our original README > > inside each board (that is good for people who likes the terminal, > > like I do) and keep the move to the site carrying on. > > > > The idea is to point the Documentation to find the README.rst inside the > > boards. > > > > So, for example inside: > > > > Documentation/platforms/arm/stm32/boards/stm32f4discovery/ > > > > we will have an index.rst that will include the file > > boards/arm/stm32/stm32f4discovery/README.rst > > > > I didn't test this solution yet, but I think it will work. > > > > So, please let me know if it makes sense for you. > > > > BR, > > > > Alan > > >
