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

boards/nucleo-g431rb & g474re: add pinouts to boards doc page #20832

Merged
merged 3 commits into from
Aug 27, 2024

Conversation

krzysztof-cabaj
Copy link
Contributor

Contribution description

This PR adds pinouts to the documentation pages for:

  • nucleo-g431rb
  • nucleo-g474re

Testing procedure

Generate doc and see if everything is fine.

make doc
xdg-open doc/doxygen/html/group__boards__nucleo-g431rb.html
xdg-open doc/doxygen/html/group__boards__nucleo-g474re.html

Issues/PRs references

None

@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Aug 23, 2024
@chrysn chrysn added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Aug 24, 2024
@riot-ci
Copy link

riot-ci commented Aug 24, 2024

Murdock results

✔️ PASSED

aff4bd4 boards/nucleo-g474re: add pinout to doc page

Success Failures Total Runtime
1 0 1 01m:17s

Artifacts

@chrysn
Copy link
Member

chrysn commented Aug 24, 2024

So far we're usually external image inclusion from their original sources in hopes that that makes copyright handling easier (it probably does because we don't copy them into a repo of which we claim it is LGPL unless noted otherwise). Is there a source we could use here?

(I'm aware that that approach is not great from a privacy PoV, but I don't have easy alternatives at hand that don't require more administrative work to correctly annotate data we think we can copy under Fair Use or any European equivalent to that US legal construct that I'm not aware of.)

@krzysztof-cabaj
Copy link
Contributor Author

@chrysn thanks for valuable comment.

Unfortunately, I cannot find these pinouts in other webpages as images or svg schematics.
I extract them directly from the STM Board Manual - and from few recent PR I add clear
statement "from STM board manual". Maybe solution for this issue will be more detailed
description, for example, "from STM user manual, UM2505/link to pdf/, page 29"?

@benpicco benpicco added this pull request to the merge queue Aug 27, 2024
Merged via the queue into RIOT-OS:master with commit b056060 Aug 27, 2024
27 checks passed
@krzysztof-cabaj
Copy link
Contributor Author

@benpicco, @chrysn thanks for support!

Do you think that adding clear source of pinouts will be beneficial for doc/project? I could do this for STM boards.

@chrysn
Copy link
Member

chrysn commented Aug 29, 2024

Yes, any image we use (linked or included) will be better with an accurate source description; ping me in any PRs for ACKs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: boards Area: Board ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants