Repository navigation
docs: ban emdash in user-facing copy, tighten data-export wordings - #1477
Merged
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #1475 (full data export). Two paired changes:
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::emittitles + bodies,echooutput from page handlers, and everydocs/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.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.mdand 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.rgagainstweb/tests/).rg "—"overdocs/src/content/docs/configuring/data-export.mdx, the rendered surface ofweb/themes/default/page_admin_export.tpl, and the user-facing strings inweb/pages/admin.export.phpreturns zero matches.?p=admin&c=exportas owner, trigger anerrorredirect via?result=error&code=presign_invalid_scheme, confirm the toast body reads as expected.Notes