-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
What to do with READMEs that are already in the Documentation ? #11058
Comments
@raiden00pl maybe instead of only remove the files just put a comment inside it with link to the site documentation. So people will find the right direction |
In that case in which folders should we leave such READMEs? In all directories ? Currently there is no consistency as to where READMEs are and where they are not. Putting a README in every directory makes no sense. Putting the README in the top dirs (arch, audio, crypto, etc) seems more reasonable but after #10980 we'll have a link to the documentation in the main README.md so I don't know if it makes sense to duplicate this information. I think more important is that the structure in Documentation reflects the structure of the repo, then navigation is much more natural and easy (at least from my perspective, i.e. working from terminal) |
@raiden00pl I agree to make the structure in Documentation to reflect the structure. I was suggesting keeping the README inside the boards because I thought you didn't want to remove it. Also having the README inside each board with the link to the right documentation could be useful for someone new to NuttX. Maybe instead the website link, it could be just a comment saying the board documentation is inside Documentation/platforms/arm/stm32f4/boards/stm32f4discovery/ This way we don't need to strictly force the boards/ structure for the Documentation/ |
At the moment we have boards under |
This sounds good to me. |
Same question as in apache/nuttx-apps#2156 but for nuttx repo
The text was updated successfully, but these errors were encountered: