nuttx
nuttx copied to clipboard
apache
docs: Add initial board docs for Tiva arch
@v01d I would like your thoughts here, the dk-tm4c129x has a lot of great information, but it seems like it is 20% about the board 40% about the architecture and 40% about NuttX. Seems like we should maybe pull most of this out into its own documentation sections? Especially around the networking and sensor stuff.
https://github.com/apache/incubator-nuttx/blob/73c13318bd535885ea2ce32bc8bbf85ecf09c513/Documentation/platforms/arm/tiva/dk-tm4c129x/index.rst
@v01d I would like your thoughts here, the dk-tm4c129x has a lot of great information, but it seems like it is 20% about the board 40% about the architecture and 40% about NuttX. Seems like we should maybe pull most of this out into its own documentation sections? Especially around the networking and sensor stuff.
https://github.com/apache/incubator-nuttx/blob/73c13318bd535885ea2ce32bc8bbf85ecf09c513/Documentation/platforms/arm/tiva/dk-tm4c129x/index.rst
Yes, I would split it as you suggest. Feel free to redistribute the content as you see fit (you can see other boards/soc docs to see what kind of content is placed in each case).
This PR has been waiting a while; I think it improves the Tiva docs, though I'm not sure why the oocd.sh script and a few per-board README.txt are being deleted. I get that much of the information in them has moved to central documentation, but perhaps the README.txt files should stay and just tell people where to find the central docs? Other than that I think it is an improvement and should be merged soon if possible.
This PR has been waiting a while; I think it improves the Tiva docs, though I'm not sure why the oocd.sh script
It is not needed anymore openocd has board support and the updated docs refer to this.
and a few per-board README.txt are being deleted. I get that much of the information in them has moved to central documentation, but perhaps the README.txt files should stay and just tell people where to find the central docs?
Why should we have it in two places? Then we have to keep them linked. Idk I really wanted to just do a first pass of moving all the docs over but I do not have the time to at the same time improve all of them.
and a few per-board README.txt are being deleted. I get that much of the information in them has moved to central documentation, but perhaps the README.txt files should stay and just tell people where to find the central docs?
Why should we have it in two places? Then we have to keep them linked. Idk I really wanted to just do a first pass of moving all the docs over but I do not have the time to at the same time improve all of them.
Fair enough. Should this be merged or do you wish to keep the PR open to work on it more?
Hi @btashton @Ouss4 @protobits, are there any objections to merging this PR? (I would like to apply the few suggested changes first.) Thanks!
