I think i'm towards -1 I agree with most things Raiden00pl said.
The only thing we are practically solving is the developer has to move to the nuttx repo to write documentation, which is in the big picture of things a fairly minor thing. But moving documentation over to apps and maintaining it in two places instead compacted into one familiar place, might make things feel just a bit more awkward. I think what makes it just a bit more awkward are cases when a driver and an app are closely related, does this make you have to jump between repos? The sync problem sounds a bit annoying as well. You are relying on maintainers spotting this PR on time and merge them at the same time. Could create confusion? But I do agree that it sounds more logical to have two separate documentations for apps and nuttx, but that might be the only up-side of things. In short, I don't think this solves a big problem and is very much a* nice to have* with quite some more problems to solve. Op do 3 jul 2025 om 21:17 schreef Nathan Hartman <hartman.nat...@gmail.com>: > Hi all, > > Right now, Documentation is in the main nuttx repository [1]. > > However, some of the Documentation there pertains to the nuttx-apps > repository. One current example is PR #16665 in nuttx repo, which is > documenting the new Xedge example located in the nuttx-apps repo. > > I think it's a little bit messy to have documentation in nuttx repo for > things that belong in nuttx-apps repo. One disadvantage is that repos can > get out-of-sync. Another disadvantage is that NuttX users are not required > to use nuttx-apps repo. They can supply their own. But, they will have > Documentation about things in nuttx-apps repo. That could be confusing > because they might see something in Documentation but will not be able to > find it. > > I suggest to create a Documentation in nuttx-apps repo and move all > apps-related docs there. So nuttx/Documentation will only document things > in the nuttx repo, and nuttx-apps/Documentation will only document things > in the nuttx-apps repo. If we do this refactoring, it will mean that the > website will need an update also, to pull docs from both sources > (nuttx/Documentation and nuttx-apps/Documentation). > > Thoughts? > > [1] https://github.com/apache/nuttx > > [2] https://github.com/apache/nuttx/pull/16665 > > [3] https://github.com/apache/nuttx-apps/pull/3120 > > Cheers, > Nathan >
