Skip to content

Sync engineering voice from canon; split repo conventions#88

Closed
moskovich wants to merge 1 commit into
mainfrom
chore/sync-engineering-voice
Closed

Sync engineering voice from canon; split repo conventions#88
moskovich wants to merge 1 commit into
mainfrom
chore/sync-engineering-voice

Conversation

@moskovich

Copy link
Copy Markdown
Contributor

Why

The engineering voice in 05-engineering-voice.mdc was a hand-maintained paraphrase that had drifted from the canonical source. It was missing the current canon sections (truth discipline, compression tics, protocol-object naming) and was one of five inconsistent copies across repos.

What

  • 05-engineering-voice.mdc is now a generated vendor of the single source of truth: feral-file/canonreference/voice/engineering.md. It carries a do-not-edit banner. Regenerate with make sync-voice in canon after editing the source.
  • 06-cli-conventions.mdc (new, hand-owned) keeps the genuinely ff-cli-specific parts that were mixed into the old file: Go-doc commenting standard, repo terminology, and CLI output rules. These are not brand voice, so they live in the repo layer, not the synced file.

Canon is private and this repo is public, so we vendor a generated copy rather than submodule canon. This is the model for the other repos with stale voice copies (ff-app, ff-exhibition, ff-source-resolver, feralfile-app).

@feralfile-bot feralfile-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewers: 1 (approve: 0, comment: 1, request-changes: 0).

Optional cleanup:

  • .cursor/rules/06-cli-conventions.mdc:10 says the file explains how the voice applies to “Go code,” but this repo is Node.js/TypeScript-first and the actual rule is Go-style documentation comments. Please reword that phrase so future agents do not infer that this repo contains or expects Go runtime code.

@moskovich

Copy link
Copy Markdown
Contributor Author

Closing — we're keeping the engineering voice internal to canon and deleting the scattered repo copies rather than vendoring/syncing them. No per-repo voice file.

@moskovich moskovich closed this Jun 29, 2026
@moskovich moskovich deleted the chore/sync-engineering-voice branch June 29, 2026 03:10
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.

2 participants