docs: link file references to their sources - #715
Merged
Conversation
Turn backticked paths in the README, AGENTS.md, CONTRIBUTING.md and docs/ into relative markdown links so each reference opens the file, directory or package it names. Rebased onto current master: driver source now lives in srcfl/device-drivers and the in-repo drivers/*.lua tree is gitignored, so driver .lua references stay plain code spans rather than links that would 404, while srcfl/device-drivers is linked to its GitHub repo. Runtime-only files (state.db, config.yaml), release artifacts (manifest.json) and wire identifiers also stay code spans. Every relative link target was verified to exist. Co-authored-by: HuggeK <48095810+HuggeK@users.noreply.github.com> Signed-off-by: Hugo Karlsson <48095810+HuggeK@users.noreply.github.com>
frahlg
added a commit
that referenced
this pull request
Jul 30, 2026
* ci: decide the changeset allowlist before validating the queue The gate ran `changeset status` before it worked out whether the PR was allowlisted. That command errors with "Some packages have been changed but no changesets were found" for any diff inside a package, and a docs-only PR is such a diff, so the check failed on exactly the PRs the allowlist exists to exempt and the exemption step never ran. PR #715 changes markdown only and fails this way today. The allowlist verdict now runs first and publishes what it decided. The Changesets queue validation still runs whenever the PR needs a changeset, and also when an allowlisted PR carries one anyway: a `.changeset/*.md` file matches the markdown allowlist, so a changeset-only PR is exempt from the gate and would otherwise ship its entry unvalidated. Co-authored-by: Claude Opus 5 <noreply@anthropic.com> * test: pin the changeset gate's step order instead of one guard string The workflow-structure test asserted that each Changesets step carried the label guard by matching the exact concatenation of both short-circuits. Adding a third condition to a step therefore read as a removed guard. It now checks the two short-circuits separately, which is as strict about the property it names and lets a step carry a further guard of its own. Adds the assertion this change is actually about: the allowlist verdict must be resolved before Changesets validation runs. Restoring the old order fails the test, so it guards the regression rather than describing it. Co-authored-by: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This was referenced Jul 30, 2026
Draft
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
3 participants
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.
Backticked file, directory and package paths in the README,
AGENTS.md,CONTRIBUTING.mdanddocs/are now relative markdown links, so each reference opens the thing it names. 14 files changed; every relative link target was verified to exist on the currentmaster.This is rebased onto the current tree, so it accounts for #712 (driver source moved to
srcfl/device-drivers,drivers/*.luagitignored).What is intentionally left as a plain code span (not linked)
.luafiles —drivers/*.lua,drivers/myuplink.lua,drivers/nibe_local.lua. These are no longer committed here (gitignored, fetched from the pinneddevice-driverscommit), so a local link would 404. Where the editable source is discussed,srcfl/device-driversis linked to its GitHub repo instead.state.db,cache.db,config.yaml,config.local.yaml,~/ftw, the legacydocker-compose.yml.manifest.json(a signed release asset),tools/ftw_download_stats.py(not in-tree).forty-two-watts/…), container image names (ghcr.io/srcfl/ftw).Why some lines rewrapped
Adding
[label](target)syntax pushed a few lines past the docs' ~80-column wrapping, so those sentences were re-wrapped. No wording changed.Docs-only change, so no changeset entry is needed (auto-exempt per
AGENTS.md).🤖 Generated with Claude Code