Skip to content

Conversation

@ArmandPhilippot
Copy link
Member

@ArmandPhilippot ArmandPhilippot commented Jan 24, 2026

Description

This was reported in #207 so instead of telling coderabbit this has nothing to do with the translation, this is probably better to fix this. 😄

  • buildkit.mdx: esBuild is not the right casing for esbuild
  • cfetch.mdx: a code snippet uses Typescript optional properties syntax for an example usage which seems wrong

Summary by CodeRabbit

  • Documentation

    • Enhanced documentation formatting and structure in the buildkit package.
  • Updates

    • CFetchConfig API: The ttl, tags, key, and verbose configuration fields are now required instead of optional. Update your implementation code to explicitly provide these fields when creating cFetch instances. This represents a breaking change that may require updates to existing code integrations.

✏️ Tip: You can customize this high-level summary in your review settings.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner January 24, 2026 20:54
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

Two documentation files updated: buildkit.mdx receives minor formatting adjustments, while cfetch.mdx updates example usage and changes the CFetchConfig interface signature from optional fields to required fields (ttl, tags, key, verbose), representing a breaking API change.

Changes

Cohort / File(s) Summary
Documentation formatting
src/content/docs/en/ecosystem/packages/buildkit.mdx
Removed leading dash from final line under "Files considered Assets," converting bullet item to regular paragraph.
API signature update and example
src/content/docs/en/ecosystem/packages/cfetch.mdx
Updated CFetchConfig interface to require ttl, tags, key, and verbose fields instead of optional. Corresponding documentation example reflects mandatory field requirements.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • dreyfus92

Poem

🐰 Hop hop, the docs take shape,
A dash removed, no great escape,
Config fields now stand tall and true,
Required now, not optional blue!
Clarity wins the day, hooray!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title claims to fix typos, but the actual changes involve documentation formatting and required field modifications, not simple typos. Update the title to accurately reflect the changes: consider 'docs: update cfetch config and buildkit formatting' or similar that describes the actual modifications made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Post copyable unit tests in a comment

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.

@studiocms-no-reply
Copy link
Member

studiocms-no-reply commented Jan 24, 2026

Lunaria Status Overview

🌑 This pull request will not trigger status changes.

Learn more

Lunaria automatically ignores changes on specific PRs by adding a ignored keyword in its title. Found: typo.

You can change this by either removing the keyword above from the PR's title, or modifying the ignoreKeywords property in your Lunaria configuration file.

Tracked Files

Note

The notes below indicate what would happen if the pull request is merged when triggering status changes. Since a ignored keyword was found in the PR's title, the status changes indicated below won't be applied.

File Note
en/ecosystem/packages/buildkit.mdx Source changed, localizations will be marked as outdated.
en/ecosystem/packages/cfetch.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Jan 24, 2026
)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@dreyfus92 dreyfus92 merged commit 926b837 into withstudiocms:main Jan 24, 2026
9 checks passed
@ArmandPhilippot ArmandPhilippot deleted the fix/cfetch-buildkit branch January 24, 2026 21:12
dreyfus92 added a commit that referenced this pull request Jan 24, 2026
…tch` (#207)

* i18n(fr): add `ecosystem/packages/buildkit` & `ecosystem/packages/cfetch`

See #194

* Apply suggestions coderabbit suggestions (changes from #211)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: paul valladares <85648028+dreyfus92@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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.

3 participants