Skip to content

[docs] Consolidate developer specifications v9.0 — tone fix and engine domain registry docs#30157

Merged
pelikhan merged 1 commit intomainfrom
docs/consolidation-2026-05-04-8f481975b3668c85
May 4, 2026
Merged

[docs] Consolidate developer specifications v9.0 — tone fix and engine domain registry docs#30157
pelikhan merged 1 commit intomainfrom
docs/consolidation-2026-05-04-8f481975b3668c85

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 4, 2026

Developer Documentation Consolidation v9.0

This PR updates developer documentation based on the daily consolidation run for 2026-05-04.

Changes Made

Files Modified

  • scratchpad/serena-tools-quick-reference.md — removed subjective "highly efficient" label
  • scratchpad/adding-new-engines.md — added "Firewall Domain Registration" section
  • scratchpad/dev.md — updated to v9.0 with change log entry

Tone Fix

serena-tools-quick-reference.md

  • Before: - **Serena Tools:** 12.32 KB (2.89% of all data) - highly efficient
  • After: - **Serena Tools:** 12.32 KB (2.89% of all data)
  • The percentage metric conveys the same information without the subjective claim

New Documentation: Firewall Domain Registration

PR #30072 introduced a centralized engineDefaultDomains map in pkg/workflow/domains.go and the public GetDefaultDomainsForEngine() API. New engines supporting the firewall now register their default allowed domains in this map.

The adding-new-engines.md spec now documents:

  1. How to declare engine default domain variables
  2. How to register in the engineDefaultDomains map
  3. The model-specific domain pattern for provider-routing engines (OpenCode/Crush/Pi)
  4. Phase 1 checklist update with the new step

Validation

✅ All markdown validated
✅ Consistent technical tone
✅ No broken links
✅ PR #30072 API changes fully documented

Review Notes

Please verify:

  1. The engine domain registry example code accurately reflects domains.go structure
  2. The tone fix in serena-tools-quick-reference.md preserves all technical content

See the discussion [Developer Documentation Consolidation - 2026-05-04] for the full consolidation report.

Generated by Developer Documentation Consolidator · ● 893.7K ·

  • expires on May 6, 2026, 2:15 PM UTC

- Fix tone issue in serena-tools-quick-reference.md: remove "highly efficient"
  label from data-size comparison (the metric speaks for itself)
- Document PR #30072 engine domain registry pattern in adding-new-engines.md:
  new "Firewall Domain Registration" section with engineDefaultDomains map
  example and model-specific domain function pattern
- Update scratchpad/dev.md to v9.0 with consolidated change log entry

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 4, 2026
@pelikhan pelikhan merged commit 59f61d0 into main May 4, 2026
@pelikhan pelikhan deleted the docs/consolidation-2026-05-04-8f481975b3668c85 branch May 4, 2026 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant