Thank you Brennan, Yes, I understood the point. Maybe an option could be keep the board documentation at Documentation/platforms/arm/stm32/boards/stm32f4discovery/ and put a symbolic link at boards/xxx/yyy/boardname/README.rst point to it.
Or just use a boards/xxx/yyy/boardname/README.txt with a single line saying the documentation is for this board is at Documentation/platforms/xxx/yyy/boards/bordname/ This way someone new to NuttX that download the source code will figure out the board documentation faster. BR, Alan On 1/19/23, 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 >> >
