Skip to content

docs: fix incorrect config key from externals to external - #2296

Open
jxhhdx wants to merge 1 commit into
farm-fe:mainfrom
jxhhdx:fix/docs-externals-key
Open

docs: fix incorrect config key from externals to external#2296
jxhhdx wants to merge 1 commit into
farm-fe:mainfrom
jxhhdx:fix/docs-externals-key

Conversation

@jxhhdx

@jxhhdx jxhhdx commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

The documentation incorrectly used externals as the config key, but the correct key is external (singular).

Closes #2268

Description:

BREAKING CHANGE:

Related issue (if exists):

Summary by CodeRabbit

  • Documentation
    • Corrected configuration examples in tutorials to reflect the current API naming conventions for external dependencies configuration.

The documentation incorrectly used `externals` as the config key,
but the correct key is `external` (singular).

Closes farm-fe#2268
@vercel

vercel Bot commented Apr 8, 2026

Copy link
Copy Markdown

@jxhhdx is attempting to deploy a commit to the Farm Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Apr 8, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bb586adb-60fa-4496-ac69-a31f8031a208

📥 Commits

Reviewing files that changed from the base of the PR and between 198bb3b and 76e51e4.

📒 Files selected for processing (1)
  • website/docs/tutorials/2-start.md

📝 Walkthrough

Walkthrough

Documentation correction updating the Farm compilation configuration example to use the correct configuration key. The compilation.externals key is changed to compilation.external and the corresponding property name is updated from plural to singular form.

Changes

Cohort / File(s) Summary
Documentation Update
website/docs/tutorials/2-start.md
Corrected configuration key names in tutorial example from compilation.externals to compilation.external, aligning documentation with valid configuration schema.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • wre232114

Poem

🐰 A typo hopped away with care,
External ✨ took the plural's dare,
From s to... nothing at the end,
The docs now work, sweet fix, dear friend!

🚥 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 pull request title clearly and accurately describes the main change: fixing an incorrect configuration key from 'externals' to 'external' in the documentation.
Linked Issues check ✅ Passed The pull request directly addresses issue #2268 by correcting the documentation to use the valid 'external' config key instead of the invalid 'externals' key.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing the documentation bug reported in issue #2268; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

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.

[Bug Report]: Request for document update

1 participant