Skip to content
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

reorganize examples #960

Closed
2bndy5 opened this issue Mar 17, 2024 · 5 comments
Closed

reorganize examples #960

2bndy5 opened this issue Mar 17, 2024 · 5 comments

Comments

@2bndy5
Copy link
Member

2bndy5 commented Mar 17, 2024

I want to reorganize the examples into 1 folder:

examples/
  linux/
  pico/
  python/
  <all Arduino examples remain as is>
Note, all Arduino examples already have their own folder in the examples folder
  AcknowledgementPayloads/
  GettingStarted/
  ManualAcknowledgements/
  old_backups/
  scanner/
  StreamingData
  encodeRadioDetails/
  InterruptConfigure/
  MulticeiverDemo/
  rf24_ATTiny/
  scannerGraphic/

It is just getting annoying to navigate. And the shell's tab-completion would work better this way.

Of course, all docs about building/running examples would need updating.

@2bndy5
Copy link
Member Author

2bndy5 commented Mar 17, 2024

Furthermore the datasheets/ and images/ folder can get put into the docs/ folder.

The only thing stopping me from suggesting that we put all lib sources into a src/ folder is the fact that the Arduino IDE will automatically try to compile everything found in a lib's src/ folder (if it exists). That would require all non-arduino utility/ sources to have an extra #ifndef ARDUINO wrapping the non-Arduino source code (including the copied bcm2835 lib).

@TMRh20
Copy link
Member

TMRh20 commented Mar 17, 2024

Not sure if this is a good idea, this will change all links to examples online also, but I guess I won't object. :p

@2bndy5
Copy link
Member Author

2bndy5 commented Mar 17, 2024

I'm not worried about links from third-party tutorials. Any incorrect link to github sources will direct users toward the repo root anyway. An incorrect link: https://github.com/nRF24/RF24/tree/master/examples/linux

Plus, it is kind of annoying that RF24Network and RF24Mesh use examples_RPi (note capitol letters) even though they are really general linux examples. I had to use an array of examples' paths for the different RF24* libs in the installer script. And, the reusable CI workflow has to take a special input for the examples path (not to mention the inconsistent py wrapper locations which had to be another input). All this because the repo structures aren't completely in sync, but I understand the different repos' history has caused this diversion.

@2bndy5
Copy link
Member Author

2bndy5 commented Mar 17, 2024

Less clutter in repo root means more chances that people will actually see/read the README when browsing.

I think all the links in the Doxygen docs change every time we publish a new docs build too. incorrect

@2bndy5
Copy link
Member Author

2bndy5 commented Mar 18, 2024

I created a github private project called "v2.0 ideas" and added this issue and #926 to it.

Closing this until we're ready to make significant changes toward v2.0.

@2bndy5 2bndy5 closed this as not planned Won't fix, can't repro, duplicate, stale Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants