Skip to content

Point Browse drivers at the published device catalog - #7

Open
HuggeK wants to merge 2 commits into
srcfl:mainfrom
HuggeK:link-driver-catalog
Open

Point Browse drivers at the published device catalog#7
HuggeK wants to merge 2 commits into
srcfl:mainfrom
HuggeK:link-driver-catalog

Conversation

@HuggeK

@HuggeK HuggeK commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

srcfl/device-drivers publishes a catalog of all 80 drivers at https://srcfl.github.io/device-drivers/, generated from its manifests and driver sources on every push. This points the site at it.

Three changes, all in index.html:

Where Change
Build section Browse driversBrowse the device catalog, pointing at the catalog
Primary nav new Devices item between Build and Community
Footer, Project column new Device catalog link

The catalog is searchable by manufacturer or model number — typing SH10RT finds the Sungrow driver — and filterable by device type, protocol, tier and control. It reports hardware evidence honestly: 5 drivers state they have been confirmed against physical hardware, 28 state they have not.

Why the catalog rather than the drivers/lua directory #6 now links

This branch was opened when Browse drivers still pointed at srcfl/ftw/tree/master/drivers, which held no driver source — the Lua files are gitignored in srcfl/ftw and fetched at build time, so the only thing on that page was BUNDLED_SOURCE.json. That original argument is spent: #6 landed first and repointed the link at srcfl/device-drivers/tree/main/drivers/lua, which does hold the source.

The catalog is still the better destination, and it does not cost contributors the path to source. It is generated from that same repository, and all 80 entries carry a source_url into drivers/lua/*.lua — so it indexes the exact directory #6 linked and adds search by manufacturer and model, plus filters for type, protocol, tier and control. A driver author still reaches the Lua; a visitor asking what FTW supports gets an answer instead of a file listing.

Write a driver keeps the URL #6 gave it — this branch never meant to change it.

Conflict with #6, and how it was resolved

#6 landed after this branch was cut and edited the same two links in the Build section's inline-actions, so GitHub marked the branch CONFLICTING. Resolved by merging base in, taking #6's Write a driver URL and this branch's catalog link for Browse drivers, as described above. The net diff against base is now exactly the three rows in the table.

Checked
  • The catalog is live: https://srcfl.github.io/device-drivers/ returns 200, serving 80 drivers. feat: publish the catalog as a page built from the repository device-drivers#51 is merged, so the hold note on the earlier revision of this description no longer applies.
  • All 20 external links on the page return 200, including the four install buttons and the docs links fix: point the site at documentation that still exists #6 repaired.
  • index.html parses with no unclosed or mismatched tags, and every internal anchor (#architecture, #extend, #community, #start, #content, #top) has a matching target.
  • Rendered locally against the real sourceful.css. The nav reads ARCHITECTURE · BUILD · DEVICES · COMMUNITY · DOCS · GITHUB ↗ and still fits one line at 1440 px. No CSS change needed.

🤖 Generated with Claude Code

The Build section linked to github.com/srcfl/ftw/tree/master/drivers, a
directory that holds no driver source — the Lua files are gitignored
there and fetched at build time, so the only thing on that page is
BUNDLED_SOURCE.json. A visitor following "Browse drivers" found no
drivers to browse.

srcfl/device-drivers now publishes a searchable catalog of all 80
drivers, generated from its manifests and driver sources. That link
replaces the dead one, and the catalog also gets a Devices item in the
primary nav and a footer entry under Project.

Signed-off-by: Hugo Karlsson <48095810+HuggeK@users.noreply.github.com>
Co-authored-by: HuggeK <48095810+HuggeK@users.noreply.github.com>
@HuggeK

HuggeK commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Once srcfl/device-drivers#51 goes live this is safe.

@HuggeK
HuggeK marked this pull request as ready for review July 30, 2026 11:00

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Repoints the landing page's driver links at the published catalog: a new Devices nav item, the "Browse drivers" action, and a footer link, all to https://srcfl.github.io/device-drivers/.

  • One blocker, and it's not in the diff: GitHub currently has this branch as CONFLICTING against base. It'll need a rebase before it can merge.
  • Every new or changed href points at the org's own Pages domain over https. No scripts, no other surface touched, nothing security-relevant.

Content reads fine and matches the catalog framing in ftw#720/#727. Safe to merge from my read once the conflict is cleared.

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Steward review (automated sweep). Three link/nav edits in index.html: "Browse drivers" now points at the published catalog, a new Devices nav item, and a Device catalog footer link. Reads clean, no security surface (static links).

Two things before this lands:

  • The branch is CONFLICTING against master, needs a rebase.
  • Your own note says to hold until srcfl/device-drivers#51 merges and Pages publishes, otherwise https://srcfl.github.io/device-drivers/ 404s. Worth confirming that's live first.

Content is good. Not merging from my side: ftw-web isn't on my merge allowlist, and this still needs the rebase + the catalog live.

Resolves the conflict this branch had against base. Both sides edited the
same two links in the Build section's inline-actions.

srcfl#6 landed after this branch was cut and repointed both links
at srcfl/device-drivers: "Write a driver" at docs/WRITING-A-DRIVER.md and
"Browse drivers" at drivers/lua. That first fix is kept as-is -- this
branch never meant to touch it, and the ftw URL on this side is only an
artifact of the older base.

"Browse drivers" takes this branch's version: the published catalog at
srcfl.github.io/device-drivers/. That is not a regression of srcfl#6's fix.
The catalog is generated from the same repository and every one of its 80
entries carries a source_url into drivers/lua/*.lua, so it indexes the
directory srcfl#6 linked and adds search by manufacturer and model plus
filters for type, protocol, tier and control. Contributors keep the path
to source; visitors get a page that answers what FTW supports.

Co-authored-by: HuggeK <48095810+HuggeK@users.noreply.github.com>
@HuggeK

HuggeK commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

Both blockers from review are cleared.

Conflict. #6 landed after this branch was cut and edited the same two links in the Build section, which is where the CONFLICTING came from. Merged base in and resolved it: Write a driver keeps the URL #6 gave it (device-drivers/blob/main/docs/WRITING-A-DRIVER.md), and Browse drivers takes this branch's catalog link. GitHub now reports the branch MERGEABLE / CLEAN.

Catalog live. srcfl/device-drivers#51 is merged and Pages has published — https://srcfl.github.io/device-drivers/ returns 200 and serves all 80 drivers. No 404 risk, so the hold note is gone from the description.

One thing worth flagging, since it changes the case for this PR rather than just restating it: the original justification no longer holds. This branch argued that Browse drivers pointed at a directory with no driver source, which was true of srcfl/ftw/tree/master/drivers. #6 already fixed that by repointing it at device-drivers/tree/main/drivers/lua, which does hold the source. So this is no longer a dead-link fix.

It still stands on its own: the catalog is generated from that same repository and every one of its 80 entries carries a source_url into drivers/lua/*.lua, so it indexes the exact directory #6 linked and adds search by manufacturer and model plus filters for type, protocol, tier and control. Contributors keep the path to source; visitors asking what FTW supports get an answer instead of a file listing. If you'd rather keep the raw directory listing in the Build section and let the new nav and footer items carry the catalog, that's a one-line change — say the word.

Also verified all 20 external links on the page return 200, index.html parses with no unclosed tags, and every internal anchor resolves.

@miravoss26 miravoss26 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Small, clean one-file change. It swaps the Browse drivers link (which pointed at ftw/tree/master/drivers, where the Lua source is gitignored) for the published catalog at srcfl.github.io/device-drivers, and adds a matching Devices nav item plus a footer Device catalog link.

  • All three targets are the same first-party GitHub Pages URL. Consistent, and the copy change reads well.
  • No script, no secrets, no new third-party origin. Nothing on the security screen.

Safe to merge from my read. ftw-web has no CI here, so a quick local open to eyeball nav spacing is the only thing I'd do first, nothing blocking.

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.

3 participants