Skip to content

Add Shipper's Logs video feed and changelog links#991

Merged
DZakh merged 2 commits into
mainfrom
feat/changelog-video-feed
Jul 8, 2026
Merged

Add Shipper's Logs video feed and changelog links#991
DZakh merged 2 commits into
mainfrom
feat/changelog-video-feed

Conversation

@Jordy-Baby

@Jordy-Baby Jordy-Baby commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Supports the new envio.dev/changelog page.

  • generate-shipper-videos.js publishes shipper-videos.json (parsed from videos.mdx) so the changelog can embed the matching Shipper's Log video per release. Wired into prestart / prebuild.
  • Adds a Changelog nav link (to envio.dev/changelog) and a link to it from the Shipper's Logs page.

The Shipper's Logs page content is otherwise unchanged.

Summary by CodeRabbit

  • New Features
    • Added a visible Changelog link in the main navigation and on the homepage for easier access to release history.
    • Updated the videos page to point users to the full written changelog.
    • Added a generated video index so release-related video content can be surfaced more consistently.

Publishes shipper-videos.json (generated from videos.mdx) so the new
envio.dev/changelog can embed the matching Shipper's Log video per
release. Also adds a Changelog nav link and a link from the Shipper's
Logs page. Shipper's Logs content is otherwise unchanged.
@Jordy-Baby Jordy-Baby requested a review from DZakh July 7, 2026 10:16
@Jordy-Baby Jordy-Baby requested a review from nikbhintade as a code owner July 7, 2026 10:16
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
envio-docs Ready Ready Preview, Comment Jul 7, 2026 11:02am

Request Review

@Jordy-Baby Jordy-Baby removed the request for review from nikbhintade July 7, 2026 10:18
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Jordy-Baby, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 16 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4536a2f1-e2c5-4dcf-8194-e0e9b0da3f5f

📥 Commits

Reviewing files that changed from the base of the PR and between df8ec15 and 55aa54e.

📒 Files selected for processing (1)
  • scripts/generate-shipper-videos.js
📝 Walkthrough

Walkthrough

Adds a "Changelog" link to the navbar, homepage, and videos page pointing to envio.dev/changelog. Introduces a new script, generate-shipper-videos.js, that parses videos.mdx and generates static/shipper-videos.json, wired into prestart and prebuild npm scripts, along with the generated JSON output.

Changes

Changelog Links and Shipper Videos Generation

Layer / File(s) Summary
Changelog links across site
docusaurus.config.js, src/pages/index.js, src/pages/videos.mdx
Adds a left-positioned "Changelog" navbar entry, a "Changelog" link in the homepage's News & Media section, and an introductory sentence linking to the Changelog on the videos page, all pointing to https://envio.dev/changelog.
Shipper videos generation script and wiring
scripts/generate-shipper-videos.js, package.json, static/shipper-videos.json
Adds a script that parses videos.mdx for version headings and <Video id="..."> entries and writes them to static/shipper-videos.json, wires it into prestart and prebuild scripts, and includes the generated JSON output.

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

Possibly related PRs

  • enviodev/docs#963: Adds a v3.0.0 release section and <Video /> entry to the same videos.mdx file parsed by the new generation script.

Suggested reviewers: DZakh

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the new Shipper's Logs video feed and added changelog links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@DZakh DZakh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you exclude this page from MCP indexing?

@Jordy-Baby Jordy-Baby requested a review from DZakh July 7, 2026 10:19

@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: 1

🤖 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 `@scripts/generate-shipper-videos.js`:
- Around line 42-54: The main issue is that main() in generate-shipper-videos.js
warns on a read failure but still writes an empty shipper-videos.json, which can
wipe existing mappings. Update the error path around parse(fs.readFileSync(...))
so a failure stops execution instead of continuing to fs.writeFileSync; let the
exception fail the build or rethrow after logging. Keep the normal write path
unchanged, and use the existing main(), VIDEOS_FILE, and OUTPUT_FILE symbols to
locate the flow.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0b9fcebd-48cc-4114-a3f4-ec36415cc8a5

📥 Commits

Reviewing files that changed from the base of the PR and between 9e41422 and df8ec15.

📒 Files selected for processing (6)
  • docusaurus.config.js
  • package.json
  • scripts/generate-shipper-videos.js
  • src/pages/index.js
  • src/pages/videos.mdx
  • static/shipper-videos.json

Comment thread scripts/generate-shipper-videos.js
Avoids silently publishing an empty shipper-videos.json, which would
drop the release videos on the changelog (CodeRabbit).
@Jordy-Baby

Copy link
Copy Markdown
Collaborator Author

@DZakh already excluded on our end. The Shipper's Logs page (/videos) is in the mcp plugin's excludeRoutes (added in #966) and I confirmed it's not in the index. This PR doesn't add any new docs pages, and the changelog page itself lives on envio.dev not docs, so the docs mcp never indexes it. Lmk if you meant a different page.

@DZakh DZakh merged commit 3358e5b into main Jul 8, 2026
3 checks passed
@DZakh DZakh deleted the feat/changelog-video-feed branch July 8, 2026 14:05
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