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

docs abstraction & code formating #36

Merged
merged 5 commits into from
Apr 7, 2021
Merged

docs abstraction & code formating #36

merged 5 commits into from
Apr 7, 2021

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Mar 31, 2021

This is part of my crusade to

  • abstract docs (main page and all "Related Pages" now live in the docs folder)
  • fix formatting (mostly was just inconsistent indentation & missing docs interlinking between class defs and config defs)
  • added a CONTRIBUTING.md file

NOTE: This lib is unlicensed.

Additional changes

@2bndy5
Copy link
Member Author

2bndy5 commented Mar 31, 2021

CI rightfully failed because it tried to push the updated docs to upstream/gh-pages branch. Remember this is the only nRF24 lib that pushes doc updates for every commit (because releases aren't used). I expect this CI error to fix itself when the PR gets merged.

@TMRh20 TMRh20 merged commit 45dc08a into nRF24:master Apr 7, 2021
@2bndy5
Copy link
Member Author

2bndy5 commented Apr 7, 2021

some hyperlinks might be broken until we merge nRF24/RF24#750 and release all the other RF24 libs

@2bndy5
Copy link
Member Author

2bndy5 commented Apr 7, 2021

Nevermind. I don't see any broken links. the docs were deployed properly here.

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

Successfully merging this pull request may close these issues.

[request] remove printf.h files in example folders
2 participants