Repository navigation
docs: refresh project entry points and first-install guides - #37
Merged
Merged
Conversation
Collaborator
Author
|
@JGAguado This one is for you as it's a bit more cosmetic and make it a bit more sexy - need to have an external view on this ;) |
JGAguado
approved these changes
Oct 21, 2026
JGAguado
left a comment
Owner
There was a problem hiding this comment.
Big improvement to the entry points and first-install path; the referenced images and files all exist. Approving.
flowcool
force-pushed
the
docs/public-docs-refresh
branch
from
October 21, 2026 15:52
b869633 to
ead2840
Compare
flowcool
referenced
this pull request
in flowcool/Smart_Plant
Oct 21, 2026
…features (#34) * feat: expose the running ESPHome version and native config hash * feat: expose the filtered soil voltage without changing calibration * fix: preserve raw gauge labels while clamping needles * fix: recover the missing KiCad symbol library from schematic caches * feat: add transport-independent low-battery protection * fix: bound standalone display recovery and invalid rendering * ci: add firmware tests workflow and CODEOWNERS Run the unit tests and validate the standalone ESPHome configuration on every PR. CODEOWNERS keeps hardware, documentation and repository governance paths under maintainer review. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: keep low-battery guide focused on user behavior * docs: remove trailing empty line from battery guide * fix: keep recovered KiCad symbol libraries LF on Windows * fix: align core display recovery and support native tests without UBSan * test: guard shared recovery parity and fresh timer budgets * test: make battery display recorder format-security safe * docs: keep recovery compatibility comments shared between entry points * fix: make public examples self-contained upstream and validate both transports * Limit test CI checkout credentials * feat: add retained MQTT maintenance and storage modes * test: adapt mode checks to merged soil diagnostics and portable libraries * fix: reconcile maintenance/storage modes with the shared display recovery Drop the globals duplicated by the #31 merge. Let the parity test accept the multi-device extensions (fault hook, counter, logs, MQTT status) and the per-profile sleep_after_display. Bound the flow tests by each profile's on_display_fault delay. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017fn1KdJJTY7LedVqZ7SxcA * feat: generate generic label bands from explicit scales and inputs * ci: install pinned label renderer dependencies for unit tests * docs: refresh project entry points and first-install guides * docs: provide firmware-matched label input and clarify defaults --------- Co-authored-by: J.G.Aguado <jon.garcia.aguado@gmail.com> Co-authored-by: J.G.Aguado <jon-garcia@hotmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A little repotting for the docs — no extra watering required. 🌱
The README points to missing images, and the first-install guide hides the useful steps between long technical notes. This refresh shows the finished product, makes Label-maker easy to find, and gives new users a continuous path from assembly to their first readings.
The instructions match the firmware currently on V2R1. They do not require the pending display changes in #31 or fork-only Maintenance commands. Existing explicit programming/flashing/support anchors are preserved.
Evidence
Documentation/Images/Top.pngandBottom.png; the FAQ asks users to copy font files although the YAML uses Google Fonts; the label generator is buried in a note.After: existing repository product photos render, the label workflow has its own page, and setup instructions match the supplied YAML.
nitpicky=True,warningiserror=True, original intersphinx mappings and a numeric 5-second inventory timeout. The legacy pinned Sphinx 5.0.2 environment was not exercised.git -c core.whitespace=cr-at-eol diff --cached --checkpass. Only the seven documentation files above change.CodeRabbit findings on the fork were also checked: calibration defaults are explicit, and the generator now uses a local, firmware-matched JSON instead of relying on changes in the companion repository. The firmware-tests badge is valid on upstream; the fork uses its own YAML-check badge.
Merge Danger
Door: two-way
Revert the documentation commit to restore the previous pages. Firmware, board files and live devices are unchanged.
Blast Radius: documentation
Navigation and first-install instructions change. The PR introduces no firmware dependency and can be reviewed independently of #31.