Skip to content

docs(prior-art): dated citation check of every rules.yaml value - #217

Draft
obvious-autobuild[bot] wants to merge 1 commit into
mainfrom
obv/basescanning-024
Draft

obvious-autobuild[bot] wants to merge 1 commit into
mainfrom
obv/basescanning-024

Conversation

@obvious-autobuild

Copy link
Copy Markdown

fleet-packet: basescanning-024

What changed

docs/04-prior-art-and-codes.md gains a dated "Citation check" section: one row per server/rules.yaml value (30 values, identical on main and t3/server), each with the cited source, whether it is reachable, what it actually says, its edition or edit date, and a status. Nine values cite public sources; the rest cite repo documents or declare no source. The section ends with a Flagged list of citation mismatches and a link-check summary. git diff shows only docs/04 (+58 lines); rules.yaml, schemas and server code are untouched.

Why

Hunter asked for every public rule citation to be checked against its source: values, reachability, dates and mismatches, written up as a dated section, with link-check output and proposed changes for Sam and Hunter. The existing "Code citations" table stays as the summary; the new section is the dated audit behind it.

Verification

Checks completed 2026-10-09:

  • git diff main t3/server -- server/rules.yaml → empty; both branches carry identical values, so one table covers both.
  • Base help articles fetched: 10280705 (edited 2026-09-30) and 10280641 (edited 2026-07-29). Quotes in the section come from those fetches. The 3 ft from AC units, fences and other batteries is in 10280641, not 10280705.
  • Austin Energy Design Criteria (effective 2023-12-12) and the Texas Gas meter-setting sheet (revised 01/22) downloaded; text extracted; quoted lines in the section. §1.9.2(C)(4) prohibits meters within a 3 ft radius of gas meters, regulators and relief valves; §1.9.2(D) asks 1 ft from exterior openings; §1.12 repeats the 3 ft radius for generation enclosures.
  • The two ICC viewer pages (NEC 110.26, IRC R328) render only in a browser: they 403 automated checks and expose a JS shell otherwise. NEC wording confirmed from public secondary copies: Table 110.26(A)(1) gives 3 ft depth for 0 to 150 V to ground in all conditions; (A)(2) is 30 in or equipment width; (A)(3) is 6 ft 6 in. IRC wording confirmed from a city ESS handout quoting R328.3.1 ("separated from each other by not less than 3 feet, except ... large-scale fire testing") and R328.4 item 3 ("not less than 3 feet from doors and windows directly entering the dwelling unit"). All secondary pages are marked as such in the section.
  • PR feat(evals): real-data evals for AR drift, wall reconstruction, coverage and the field test #12 read back on GitHub: its ADVIO table reports ARKit-vs-ARCore distance disagreement at median/p90 2.8/8.2 in after 3 ft, 8.6/22.3 after 10 ft, 25.7/60.1 after 30 ft (2018 iPhone 6s, ARKit 1.0), while its position error against ADVIO truth is p90 18.6 to 132.6 in, "two to three times the server's 0.16 ft per ft allowance", with scale reading 5 to 17% short.
  • npx --yes markdown-link-check on the edited file with browser headers: 16 links checked, 11 fine, 5 flagged, all status 403 (Esri blog + four Roboflow Universe pages); without browser headers the two ICC pages were flagged as well. Each flagged page loads in a browser or through a crawler, so these are bot blocks, not dead links. Roboflow dataset sizes match the doc (402, 1.4k, 1.9k images).
  • Coverage check: every source string in rules.yaml (30 values) has a row in the section; counted with a script against the file.

Not verified: ICC code text on the cited ICC pages themselves (403 to automated access; secondary copies stand in, and the section says so). The safety framing of the values themselves: this audit checks citations, not whether any placement is safe or code-compliant, and the section opens with that line.

Proposed changes for Sam and Hunter

Values and code are unchanged; these are citation fixes for you to accept or decline.

  1. clearances.ac_ft, clearances.battery_ft, facing.min_ft: say which help article (10280641) instead of "Base help page". The placement article (10280705) carries the gas 3 ft, the 20 ft meter distance and the 1 ft wall distance; the photo-checklist article carries the AC, fence and other-battery clearances.
  2. clearances.gas_ft: mark the Austin Energy and Texas Gas parts as meter-siting rules applied by analogy. Both put electric meters and outlets 3 ft from gas equipment; neither regulates battery placement.
  3. clearances.battery_ft: R328.3.1's exception is "large-scale fire testing" (the California-edition copy ties it to CFC 1207.1.5 rather than naming UL 9540A). Either quote the code or keep the paraphrase with a note.
  4. errors.drift_per_ft: label the p90s (8.2/22.3/60.1 in) as ARKit-vs-ARCore disagreement and note PR feat(evals): real-data evals for AR drift, wall reconstruction, coverage and the field test #12's position error against truth ran 2 to 3 times the allowance; replace "mostly ~7% scale error" with "5 to 17% short".
  5. errors.tape_ft: 0.05 ft rounds the stated half-inch resolution (0.0417 ft) up. Change the value or say it is rounded.
  6. docs/04 Hardware bullet: drop "an 11 kW inverter" (not in the cited pv magazine article) and soften "a UL listing" to the article's "certified under relevant UL and IEEE safety standards".
  7. docs/04 Code citations: keep the ICC viewer links, with a note that their text is not machine-readable and was confirmed from public secondary copies.

Risk

Low: documentation only. The audit changes no values, no code and no schema; the flagged items list what Sam and Hunter may want to change next.

Checklist

  • The scope is focused; related changes belong together
  • I explained what changed and why
  • N/A before/after images: documentation-only change, nothing visible in the app
  • N/A video: no motion or interaction change

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ac85aa80-6bfd-418d-acc6-ce27c98ca322

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the size:M 30-99 effective changed lines. label Oct 9, 2026
@obvious-autobuild
obvious-autobuild Bot force-pushed the obv/basescanning-024 branch from 2fb9266 to b02e44b Compare October 9, 2026 19:28

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 effective changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants