docs: document the Branding module across README, docs site, and website#276
Merged
Conversation
The Branding module shipped in #273 without any documentation outside its screenshots README. Sync the docs: - Add docs/site/guide/branding.md covering the /branding/manage admin page, settings-backed storage, head injection, the branding shared prop, API endpoints, and security hardening; register it in the sidebar under Infrastructure. - Document the IInertiaHeadContributor extension point in the Inertia guide and add the <!--HEAD_CONTRIBUTIONS--> placeholder to the HTML shell walkthrough (both were introduced by the Branding PR). - Add Branding to the README module list and the project-structure tree (also adding Identity, Keycloak, and Notifications, which were missing from that tree). - Add a Branding card to the website module showcase and bump the built-in module count to 17.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The Branding module shipped in #273 without any documentation outside its screenshots README (
docs/branding/README.md). This PR syncs the docs with it:docs/site/guide/branding.md— covers the/branding/manageadmin page andBranding.Managepermission, how values are stored viaISettingsContractsunderbranding.*keys (intentionally notSettingDefinitions), server-side head injection, thebrandingInertia shared prop, the API endpoints (including the anonymous asset-serve path and why it exists), and the security hardening (no SVG, nosniff,javascript:link sanitization, 2 MB upload cap). Registered in the VitePress sidebar under Infrastructure.IInertiaHeadContributorextension point introduced by the Branding PR, adds theHEAD_CONTRIBUTIONScomment placeholder to the HTML-shell walkthrough (the snippet had gone stale vs. the realwwwroot/index.html), and mentions the substitution in the request-time rendering description.Branding/to themodules/tree, plusIdentity/,Keycloak/, andNotifications/, which were already missing from that tree.website/index.html) — adds a Branding card to the "Batteries included" module showcase and bumps the built-in module count from 16 to 17.Verification
npm run buildindocs/site(VitePress) passes, including its dead-link check for the new page and sidebar entry.