Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add sponsor footer#10182

Merged
jdx merged 10 commits into
mainfrom
codex/add-sponsors-docs-page
Jun 2, 2026
Merged

docs: add sponsor footer#10182
jdx merged 10 commits into
mainfrom
codex/add-sponsors-docs-page

Conversation

@jdx

@jdx jdx commented May 31, 2026

Copy link
Copy Markdown
Owner

Summary

Validation

  • mise x node@22 -- npm run docs:build

Note

Low Risk
Marketing/docs and a read-only CLI print; the footer only fetches public JSON with basic URL checks and has no impact on tool/runtime behavior.

Overview
Adds sponsor visibility across the README, docs site, and CLI.

The README gains a centered line crediting 37signals. The VitePress layout renders a new EndevSponsors block above the footer: it loads https://en.dev/sponsors.json at runtime (timeout, URL validation, anchor/premier/partner tiers only) and shows logos plus a link to the full sponsor list, with a graceful error state if the feed fails.

A new mise sponsors subcommand prints a short static message about en.dev sponsorship; help surfaces are updated (mise.usage.kdl, man page, CLI index, Fig completions, generated sponsors.md).

Reviewed by Cursor Bugbot for commit f0157c4. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • New Features

    • Added a sponsors section to the docs that displays partner logos, handles unavailable feeds gracefully, and includes a "View all sponsors" link.
    • Added a CLI command to print sponsorship information.
  • Documentation

    • Updated README to include a centered sponsor acknowledgment in the header.

@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a README sponsorship line, a new CLI sponsors subcommand that prints sponsorship text, and a VitePress EndevSponsors component that fetches, validates, and displays sponsor logos in the docs layout.

Changes

Sponsorship Integration

Layer / File(s) Summary
Sponsorship messaging: README and CLI command
README.md, src/cli/mod.rs, src/cli/sponsors.rs
README.md header adds a centered "Sponsored by 37signals" link. A new Sponsors CLI subcommand is registered (Commands::Sponsors) and dispatched to call Sponsors::run, which prints hardcoded sponsorship text.
Docs sponsors component with remote data and layout integration
docs/.vitepress/theme/EndevSponsors.vue, docs/.vitepress/theme/Layout.vue
New EndevSponsors component fetches https://en.dev/sponsors.json (with timeout), validates and filters entries by safe URLs and allowed footer tiers (anchor, premier, partner), renders sponsor logos with a "View all sponsors" CTA or shows "Sponsor feed unavailable." on failure; component is imported and mounted in the layout's layout-bottom slot and includes scoped styles.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Sponsors hop into view so bright,
README, CLI, and docs take flight,
Logos fetched with careful care,
A tiny banner placed with flair,
Hooray for sponsors, shining light! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add sponsor footer' accurately summarizes the main change: adding sponsor-related components to the documentation, specifically a footer sponsor strip via EndevSponsors component in Layout.vue.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/add-sponsors-docs-page

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

@greptile-apps

greptile-apps Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR surfaces mise sponsorship in three places: a sponsor acknowledgment in the README header, a new EndevSponsors footer widget on the docs site, and a mise sponsors CLI subcommand.

  • EndevSponsors.vue fetches https://en.dev/sponsors.json at runtime with a 5 s timeout, validates sponsor objects (HTTPS logos, safe URLs, required fields), filters to anchor/premier/partner tiers, and hides itself entirely when no sponsors match—with a graceful fallback message on fetch failure.
  • mise sponsors is a simple synchronous CLI command that prints a hardcoded acknowledgment and a link to the full sponsors page.
  • Supporting changes wire the new command into the CLI router, usage spec, man page, Fig completions, and docs sidebar.

Confidence Score: 5/5

Safe to merge — all changes are additive, display-only, and do not touch tool installation, config parsing, or any security-sensitive path.

The frontend widget performs proper URL/protocol validation, uses AbortController for timeout, and hides itself cleanly when the feed is empty or unavailable. The CLI command is trivially simple. No existing behavior is modified.

No files require special attention.

Important Files Changed

Filename Overview
docs/.vitepress/theme/EndevSponsors.vue New component that fetches sponsors.json at runtime, validates URLs and HTTPS logos, filters by tier, handles errors gracefully, and hides itself when no sponsors match.
docs/.vitepress/theme/Layout.vue Adds EndevSponsors above EndevFooter in the layout-bottom slot; clean import and usage.
src/cli/sponsors.rs New CLI subcommand printing a hardcoded sponsorship message; simple and correct, run() is synchronous unlike most other commands.
src/cli/mod.rs Registers the sponsors module and dispatches the Sponsors variant without .await, consistent with run() being synchronous.
README.md Adds a centered sponsor line in the header crediting 37signals with a link.
docs/cli/sponsors.md Auto-generated CLI reference page for mise sponsors; no issues.
mise.usage.kdl Adds sponsors command entry to the usage spec; consistent with other single-action commands.
xtasks/fig/src/mise.ts Adds sponsors to the Fig shell completion spec; correctly placed and described.

Reviews (10): Last reviewed commit: "docs: render sponsors command artifacts" | Re-trigger Greptile

Comment thread docs/sponsors.md Outdated
Comment thread docs/sponsors.md Outdated
@jdx jdx force-pushed the codex/add-sponsors-docs-page branch from 6df251f to 3d2bea2 Compare May 31, 2026 18:32
@jdx jdx changed the title [codex] Add sponsors docs page docs: add sponsors page May 31, 2026
@jdx jdx marked this pull request as ready for review May 31, 2026 18:32

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/sponsors.md`:
- Line 29: The filter currently assumes each entry is an object and accesses
s.name and s.url directly; update the filter used on (feed.value?.paid ||
feed.value?.sponsors || []) to first ensure s is a non-null object (e.g., s &&
typeof s === 'object') and that name and url are present and of expected types
(e.g., typeof s.name === 'string' and typeof s.url === 'string') before
returning true so malformed primitives or nulls from the remote feed are
skipped; apply the same guard to the other identical filter usage.
- Line 51: Change the phrase "en.dev open source project family" to use the
hyphenated adjective "open-source" so the sentence reads "These companies
support the en.dev open-source project family." Locate the sentence string in
docs/sponsors.md (the line containing "These companies support the en.dev open
source project family.") and replace "open source" with "open-source".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 42633700-43c4-43bb-b380-0feab69a8a1b

📥 Commits

Reviewing files that changed from the base of the PR and between 2377123 and 3d2bea2.

📒 Files selected for processing (2)
  • docs/.vitepress/config.ts
  • docs/sponsors.md

Comment thread docs/sponsors.md Outdated
Comment thread docs/sponsors.md Outdated
Comment thread docs/sponsors.md Outdated
@github-actions

github-actions Bot commented May 31, 2026

Copy link
Copy Markdown

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.5.18 x -- echo 19.1 ± 0.8 17.4 22.5 1.00
mise x -- echo 19.6 ± 1.7 18.0 51.2 1.03 ± 0.10

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.5.18 env 19.3 ± 1.2 16.9 26.1 1.00
mise env 20.9 ± 1.5 18.0 27.2 1.08 ± 0.10

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.5.18 hook-env 21.1 ± 1.4 17.8 25.8 1.00
mise hook-env 22.6 ± 1.5 19.0 28.0 1.07 ± 0.10

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.5.18 ls 17.7 ± 1.4 14.2 22.6 1.00
mise ls 19.3 ± 1.5 15.5 24.8 1.09 ± 0.12

xtasks/test/perf

Command mise-2026.5.18 mise Variance
install (cached) 151ms 153ms -1%
ls (cached) 67ms 66ms +1%
bin-paths (cached) 77ms 78ms -1%
task-ls (cached) 147ms 148ms +0%

@jdx jdx changed the title docs: add sponsors page docs: add sponsor footer Jun 2, 2026
@jdx jdx enabled auto-merge (squash) June 2, 2026 17:14

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ce03eb6. Configure here.

Comment thread src/cli/sponsors.rs
@jdx jdx merged commit 80f419d into main Jun 2, 2026
35 checks passed
@jdx jdx deleted the codex/add-sponsors-docs-page branch June 2, 2026 20:17
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