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

Update Fan Cases with mention of the Pi 4 Case Fan #3929

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

nllho
Copy link

@nllho nllho commented Nov 21, 2024

Resolves #3566.

Keeping it minimal here! My thinking (for these types of tickets in general) is that if the current/latest model is already documented, we only need to include previous models for completeness. That means that we won't have the finer details of Pi 4 fan behaviour in the doc (at least until there's a good use case to go around and dig them up!) The assembly and usage instructions for both fans can be found on their respective product pages and product briefs.

Other notes (just general tech writing thoughts):

  • Since I chose to keep the Pi 4 fan mention quite short, I didn't create a new section for it.
  • I put the mention at the top of the Fan Cases section, rather than at the bottom. That particular section ends with a table, and in general I'll avoid placing short pieces of information right below tables or graphics, since that makes them somewhat easy to miss.
  • I made some small readability updates to reinforce the fact that the detailed information refers to the Pi 5 fan only.

Copy link
Collaborator

@nathan-contino nathan-contino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement. Your additions made me think a little more critically about the section layout, so I made some suggestions. Address my nitpicky suggestions and we'll merge this in!

Copy link
Collaborator

@nathan-contino nathan-contino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Copy link
Author

@nllho nllho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @nathan-contino! The nits are very helpful, especially early on -- I can start to see how much editing and rewriting we want to aim for in these types of PRs.

Have reviewed the style guide (and will reread it often, I'm sure). For future issues, in addition to making changes addressed in the issue, I'll think about style and structure edits at roughly the same "level" as you're suggesting here :)

@@ -78,9 +86,9 @@ Temperature decreases use the same mapping with a 5°C **hysteresis**; fan speed

At boot the fan is turned on, and the tachometer input is checked to see if the fan is spinning. If it is, then the `cooling_fan` device tree overlay is enabled. This overlay is in `bcm2712-rpi-5-b.dtb` by default, but with `status=disabled`.

==== Fan connector pinout
==== Raspberry Pi 5 fan connector pinout
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more nit 😁 Thoughts on this header? It's at the same level as the other "fan" headers (I didn't want to make it too small). Normally I don't think I would separate this information out using a header, but in this case, the connector info is linked in the introduction.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a reasonable compromise. Ideally we'd nest this within the Pi 5 section, but... that might go too deep. This seems to be the best place for this right now.

@nathan-contino nathan-contino merged commit de44d4a into develop Nov 21, 2024
1 check passed
@nathan-contino nathan-contino deleted the update-case-fans-pi4 branch November 21, 2024 21:35
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.

Need to mention the Raspberry Pi 4 Case Fan in the thermals section
2 participants