Skip to content

docs: document the Branding module across README, docs site, and website#276

Merged
antosubash merged 1 commit into
mainfrom
claude/docs-update-wnrfxy
Jul 10, 2026
Merged

docs: document the Branding module across README, docs site, and website#276
antosubash merged 1 commit into
mainfrom
claude/docs-update-wnrfxy

Conversation

@antosubash

@antosubash antosubash commented Jul 9, 2026

Copy link
Copy Markdown
Owner

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:

  • New docs page docs/site/guide/branding.md — covers the /branding/manage admin page and Branding.Manage permission, how values are stored via ISettingsContracts under branding.* keys (intentionally not SettingDefinitions), server-side head injection, the branding Inertia 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.
  • Inertia guide — documents the IInertiaHeadContributor extension point introduced by the Branding PR, adds the HEAD_CONTRIBUTIONS comment placeholder to the HTML-shell walkthrough (the snippet had gone stale vs. the real wwwroot/index.html), and mentions the substitution in the request-time rendering description.
  • README — adds Branding to the module list in the project-structure section.
  • Project Structure page — adds Branding/ to the modules/ tree, plus Identity/, Keycloak/, and Notifications/, which were already missing from that tree.
  • Marketing site (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 build in docs/site (VitePress) passes, including its dead-link check for the new page and sidebar entry.

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.
@antosubash antosubash marked this pull request as ready for review July 10, 2026 04:39
@antosubash antosubash merged commit 7e84399 into main Jul 10, 2026
10 checks passed
@antosubash antosubash deleted the claude/docs-update-wnrfxy branch July 10, 2026 04:39
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