Skip to content

Refactor signals documentation as formal RFC-style specification#866

Merged
bokelley merged 1 commit into
mainfrom
bokelley/doc-naming-cleanup
Jan 25, 2026
Merged

Refactor signals documentation as formal RFC-style specification#866
bokelley merged 1 commit into
mainfrom
bokelley/doc-naming-cleanup

Conversation

@bokelley

Copy link
Copy Markdown
Contributor

Summary

Simplify page titles and transform signals specification from verbose documentation into concise, normative RFC-style format. Fixes schema alignment issues and adds testable JSON validation.

Changes

  • Simplified page titles for cleaner navigation in docs
  • Fixed activate_signal requirements to use is_live boolean matching actual schema
  • Added $schema reference to JSON example for CI validation
  • Removed invalid tasks field from capabilities example
  • Condensed explanatory sections into focused spec requirements
  • Added explicit Transport, Conformance, and Security sections

Testing

All 262 tests pass, including schema validation. JSON example validates against get-adcp-capabilities-response.json.

Simplify page titles and transform signals specification from verbose
documentation into concise, normative RFC-style format. Fix schema
alignment issues and add testable JSON validation.

- Simplify page titles (remove "Protocol" prefix for cleaner navigation)
- Update last-modified date to January 25, 2026
- Add RFC 2119 normative language reference
- Fix activate_signal requirements to use `is_live` boolean matching schema
- Add $schema reference to JSON example for CI validation
- Remove invalid `tasks` field from capabilities example
- Condense explanatory sections into focused spec requirements
- Add Transport Requirements section
- Add explicit Conformance section for agents and orchestrators
- Restructure Core Concepts to be more specification-focused

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@bokelley bokelley merged commit f370d68 into main Jan 25, 2026
7 of 8 checks passed
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.

1 participant