Skip to content

🎨 Apply the brand skin to the docs - #699

Merged
vinceglb merged 3 commits into
mainfrom
docs/visual-skin
Oct 28, 2026
Merged

vinceglb merged 3 commits into
mainfrom
docs/visual-skin

Conversation

@vinceglb

@vinceglb vinceglb commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

What

Applies the new brand to the docs site and adds the live demo to two more pages.

  • docs/docs.json: brand colors from brand/palette.json (primary #1A7F4B, light #E3C266, dark #1A7F4B), the new light and dark logos, the brand favicon, and a site-wide Open Graph image (/brand/og.jpg, large Twitter card).
  • docs/introduction.mdx: the landing page uses the rendered hero (/brand/hero.webp). It drops the Frame because the image already has rounded corners.
  • docs/style.css: makes the navbar logo smaller (22px instead of 28px). The brand logo is cropped tight to its ink, so it looked too large at the default height.
  • Live demo embeds on Gallery picker and Directory picker, as a "Try it" section like the one on File picker. The camera picker, file saver, and share file pages get no embed, because the web sample marks those screens as unsupported.
  • Removes the old assets (docs/logo/*, docs/images/hero-*, docs/favicon.svg). Nothing in the repo references them anymore.

Platforms

Docs only. No library or sample changes.

Validation

  • mint dev: checked the landing page, File picker, Gallery picker, and Directory picker in light and dark mode. Clicking "Run live demo" loads the deployed sample on the right screen with the matching theme.
  • mint broken-links: no broken links.
  • Page paths are unchanged, so no redirects are needed.

Follow-up

  • The deployed web sample still uses its previous colors. The sample brand update (🎨 Put the sample apps on the FileKit brand #698) will make the embeds match the docs once it ships.
  • The Open Graph image uses the absolute https://filekit.mintlify.app URL. Update it if the docs move to a custom domain.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added interactive directory-picker and gallery-picker demos, with guidance for browsing folders, inspecting file metadata, and trying the browser samples.
    • Updated the introduction page with a full-width hero image and descriptive alt text.
  • Style
    • Refreshed documentation theme colors, branding assets, and social sharing metadata.
    • Adjusted the navigation logo height.

vinceglb and others added 3 commits October 28, 2026 21:05
Brand colors from brand/palette.json, new logos, favicon, Open Graph image,
and the rendered hero on the landing page. Remove the old logo, hero, and
favicon files, which nothing references anymore.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-28T20:12:09.471566Z 2dcc608 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ee4ed4a1-1a86-4ca0-baae-2b651e4fb3f0
Commits

Reviewing files that changed from the base of the PR and between 7e85bec and 2dcc608.

Files ignored due to path filters: 10
  • docs/favicon.svg is excluded by !**/*.svg
  • docs/images/hero-10.png is excluded by !**/*.png
  • docs/images/hero-13.png is excluded by !**/*.png
  • docs/images/hero-dark.svg is excluded by !**/*.svg
  • docs/images/hero-light.svg is excluded by !**/*.svg
  • docs/logo/dark-0.10.2.svg is excluded by !**/*.svg
  • docs/logo/dark.svg is excluded by !**/*.svg
  • docs/logo/light-0.10.2.svg is excluded by !**/*.svg
  • docs/logo/light-0.10.svg is excluded by !**/*.svg
  • docs/logo/light.svg is excluded by !**/*.svg
Files selected for processing: 5
  • docs/dialogs/directory-picker.mdx
  • docs/dialogs/gallery-picker.mdx
  • docs/docs.json
  • docs/introduction.mdx
  • docs/style.css

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 3 remain after this review.

Walkthrough

The documentation adds embedded directory-picker and gallery-picker demos. It also updates documentation theme colors, brand image paths, social metadata, the introduction hero image, and navbar logo styling.

Changes: Picker demos

Layer / File(s) Summary
Embed picker demos
docs/dialogs/directory-picker.mdx, docs/dialogs/gallery-picker.mdx
Both pages import FileKitDemo and add a “Try it” section describing and embedding the corresponding browser demo.

Documentation branding

Layer / File(s) Summary
Theme and social metadata
docs/docs.json
Theme colors and favicon and logo paths change. Open Graph image metadata and Twitter large-image card metadata are added.
Hero and navbar images
docs/introduction.mdx, docs/style.css
The introduction uses /brand/hero.webp with descriptive alt text, dimensions, full-width rounded styling, and noZoom. The navbar logo height is set to 1.375rem.

Priority: Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Possibly related PRs

  • vinceglb/FileKit#694: Adds the FileKitDemo component and the demo identifiers used by the new embeds.
  • vinceglb/FileKit#698: Applies the brand palette and favicon to the web sample, which the PR summary notes is handled separately.
  • vinceglb/FileKit#695: Adds the brand asset pipeline that generates the documentation images and icons used here.
Merge Risk: Minimal · up to 2dcc6

The documentation branding and picker demos are ready to merge with no supported material risk identified.

Architecture risk: Low · up to 2dcc6

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 5 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/dialogs/directory-picker.mdx: Added the FileKitDemo import.
  • observed — Modified behavior in docs/dialogs/directory-picker.mdx: Added a “Try it” section describing the browser directory-picker demo and embedding it with the directory-picker demo identifier.
  • observed — Modified behavior in docs/dialogs/gallery-picker.mdx: Adds the FileKitDemo import for embedding the sample.
  • observed — Modified behavior in docs/dialogs/gallery-picker.mdx: Adds a “Try it” section describing image, video, selection-mode, and metadata interactions in the browser, and embeds the gallery-picker demo.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the primary change: applying the new brand styling to the documentation site.
Description check Passed The description explains the changes, affected scope, validation steps, and follow-up items. It does not include the template's checklist or issue-closing reference, but the main required information …
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the changes, affected scope, validation steps, and follow-up items. It does not include the template's checklist or issue-closing reference, but the main required information is present.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@vinceglb
vinceglb merged commit b87f8e3 into main Oct 28, 2026
20 checks passed
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.

1 participant