Skip to content

docs: ban emdash in user-facing copy, tighten data-export wordings - #1477

Merged
rumblefrog merged 1 commit into
mainfrom
chore/no-emdash-rule-and-export-wording-fix
May 27, 2026
Merged

rumblefrog merged 1 commit into
mainfrom
chore/no-emdash-rule-and-export-wording-fix

Conversation

@rumblefrog

Copy link
Copy Markdown
Member

Summary

Follow-up to #1475 (full data export). Two paired changes:

  • New Conventions block in AGENTS.md — User-facing text style (panel UI + docs). Three rules: no emdash (—), terse, don't over-explain. Scoped to the surfaces operators read: web/themes/default/**/*.tpl, \Sbpp\View\Toast::emit titles + bodies, echo output from page handlers, and every docs/src/content/docs/**/*.{md,mdx} page. Explicit carve-out for contributor docs (AGENTS.md, ARCHITECTURE.md, etc.), PHP/JS/Smarty code comments, audit-log entries, and test fixtures. Paired Anti-patterns entries pin the rule.
  • Wording fixes on the surfaces feat(export): full data export — ZIP download + S3 presigned upload #1475 added:
    • web/themes/default/page_admin_export.tpl — page intro, bundle summary, cap-exceeded body, ZIP and S3 form descriptions.
    • web/pages/admin.export.php — sbpp_admin_export_describe_error() error-code translations.
    • docs/src/content/docs/configuring/data-export.mdx — every section rewritten for terseness; emdashes removed.

The rule covers the user-visible surface only. AGENTS.md and code comments still use emdashes freely; both halves of the carve-out are documented.

Test plan

  • ./sbpp.sh phpstan — clean.
  • ./sbpp.sh ts-check — clean (no JS touched).
  • ./sbpp.sh test --filter='ExportBundleWriterTest|EntityExporterTest|ManifestBuilderTest|AdminExport|S3PresignedUploaderTest' — 44 tests, 603 assertions, green.
  • No test pinned the rewritten strings (verified by rg against web/tests/).
  • rg "—" over docs/src/content/docs/configuring/data-export.mdx, the rendered surface of web/themes/default/page_admin_export.tpl, and the user-facing strings in web/pages/admin.export.php returns zero matches.
  • Manual smoke: render ?p=admin&c=export as owner, trigger an error redirect via ?result=error&code=presign_invalid_scheme, confirm the toast body reads as expected.

Notes

- AGENTS.md: new "User-facing text style (panel UI + docs)" Conventions
  block. Three rules, applies to .tpl + Toast::emit + docs prose. Carve-out
  for contributor docs and code comments. Paired anti-pattern entries.
- web/pages/admin.export.php: shorten error-code translations.
- web/themes/default/page_admin_export.tpl: shorter labels and helper text,
  no emdashes in the rendered surface.
- docs/src/content/docs/configuring/data-export.mdx: rewrite for terseness;
  no emdashes.

Follow-up to #1475.
@rumblefrog
rumblefrog added this pull request to the merge queue May 27, 2026
Merged via the queue into main with commit 58f2ce3 May 27, 2026
6 checks passed
@rumblefrog
rumblefrog deleted the chore/no-emdash-rule-and-export-wording-fix branch May 27, 2026 21:22
@github-actions github-actions Bot locked and limited conversation to collaborators May 27, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant