Alan-Jowett / sonde / 23703880052
82%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 77
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 85.722%. Remained the same
23703880052

push

github

web-flow 
docs: add cross-cutting error diagnostic observability requirements (#562)

* docs: add cross-cutting error diagnostic observability requirements

Add a new requirement to each component spec mandating that errors at
user-facing or operator-visible boundaries include: the failed operation,
triggering input/parameters, underlying subsystem error, and actionable
guidance where possible.

New requirements:
- GW-1307  Error diagnostic observability (gateway)
- ND-1014  Error diagnostic observability (node)
- MD-0506  Error diagnostic observability (modem)
- PT-1215  Error diagnostic observability (pairing tool)

Appendix indexes updated in all files that have them.

Closes #532

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: address review findings for error diagnostic observability

- Add missing --- separators before PT-1215, ND-1014, MD-0506
- Add crypto/secret redaction wording to PT-1215 (references PT-0900)
- Add secret redaction wording to ND-1014 and GW-1307
- Update MD-0506 description and acceptance criteria to restrict
  logging to non-sensitive metadata only
- Fix Source capitalization in GW-1307 (issue -> Issue)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: replace SSID example with scan config in ND-1014

Replace privacy-sensitive SSID example with WiFi scan configuration
parameters (channels, dwell/timeout, active vs passive) and add
explicit guidance that discovered network identifiers (SSID/BSSID)
SHOULD NOT be logged unless strictly necessary.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: clarify PT-1215 relationship to PT-1212

PT-1215 (error diagnostic observability) extends PT-1212 (error logging
with actionable context) for user-facing error boundaries specifically,
adding requirements for triggering parameters, subsystem error codes,
and security redaction constraints.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>... (continued)

23228 of 27097 relevant lines covered (85.72%)

155.87 hits per line

Jobs
ID Job ID Ran Files Coverage
1 23703880052.1 77
85.72
 GitHub Action Run
Source Files on build 23703880052