Improve scalar docs: document 'cdn' setting #3006

IvaDey · 2025-03-11T11:13:53Z

Information

Type	Breaking change
Fix	No
Doc	No

Document cdn setting of scalar and remove _integration from settings because the "tsed" value is not supported by the latest version of @scalar/api-reference.

Summary by CodeRabbit

Refactor
- Streamlined configuration settings by removing an obsolete integration detail for a cleaner structure.
Documentation
- Corrected the formatting of "Ts.ED" in the Scalar documentation for consistency.
- Improved clarity in the documentation table header with formatting adjustments.

…d by the latest @scalar/api-reference

coderabbitai · 2025-03-11T11:14:02Z

Caution

Review failed

The pull request is closed.

Walkthrough

The update removes the _integration property from the settings object in the ScalarModule and from the opts object in the indexMiddleware function. Additionally, a minor correction was made in the documentation to ensure consistent formatting of "TsED."

Changes

File(s)	Change Summary
`packages/specs/scalar/.../ScalarModule.ts` `packages/specs/scalar/.../indexMiddleware.ts`	Removed the `_integration` property (previously set to `"tsed"`) from the returned objects/options. Other properties remain unchanged.
`docs/.../scalar.md`	Corrected the formatting of "TsED" from "Ts.ED" to ensure consistency.

Possibly related PRs

Improve scalar docs: document 'cdn' setting #3006: The changes in the main PR are directly related to those in the retrieved PR, as both involve the removal of the _integration property from the respective objects in the same files.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06e445c and d6bc786.

📒 Files selected for processing (2)

docs/tutorials/scalar.md (2 hunks)
docs/tutorials/scalar.md (3 hunks)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0cd0f2 and d704b2b.

📒 Files selected for processing (3)

packages/specs/scalar/src/ScalarModule.ts (0 hunks)
packages/specs/scalar/src/middlewares/indexMiddleware.ts (0 hunks)
docs/tutorials/scalar.md (2 hunks)

💤 Files with no reviewable changes (2)

packages/specs/scalar/src/middlewares/indexMiddleware.ts
packages/specs/scalar/src/ScalarModule.ts

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/tutorials/scalar.md

96-96: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

112-112: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms (9)

GitHub Check: test-third-parties (20.12.2)
GitHub Check: test-specs (20.12.2)
GitHub Check: test-security (20.12.2)
GitHub Check: test-platform (20.12.2)
GitHub Check: test-graphql (20.12.2)
GitHub Check: test-orm (20.12.2)
GitHub Check: test-core (20.12.2)
GitHub Check: lint (20.12.2)
GitHub Check: CodeQL-Build

docs/tutorials/scalar.md

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d704b2b and 06e445c.

📒 Files selected for processing (2)

docs/tutorials/scalar.md (2 hunks)
docs/tutorials/scalar.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/tutorials/scalar.md

96-96: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

112-112: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms (9)

GitHub Check: test-third-parties (20.12.2)
GitHub Check: test-specs (20.12.2)
GitHub Check: test-security (20.12.2)
GitHub Check: test-platform (20.12.2)
GitHub Check: test-orm (20.12.2)
GitHub Check: lint (20.12.2)
GitHub Check: test-graphql (20.12.2)
GitHub Check: test-core (20.12.2)
GitHub Check: CodeQL-Build

🔇 Additional comments (2)

docs/tutorials/scalar.md (2)

75-80: Capitalize "URL" in the cdn Option Description

In the options table, the new cdn row currently describes the URL as “Url to the @scalar/api-reference package.” To improve clarity and consistency with common usage, please change “Url” to “URL.”
-| cdn                  | `https://cdn.jsdelivr.net/npm/@scalar/api-reference`          | Url to the @scalar/api-reference package.                                                             |
+| cdn                  | `https://cdn.jsdelivr.net/npm/@scalar/api-reference`          | URL to the @scalar/api-reference package.                                                             |
🧰 Tools

🪛 LanguageTool

[uncategorized] ~79-~79: Did you mean: “By default,”?
Context: ... | OpenAPI file name. By default openapi.json. ...

(BY_DEFAULT_COMMA)

1-180: Overall Documentation Update Approved

The updated documentation successfully introduces the new cdn configuration option and removes the deprecated _integration setting as intended. The structure is clear and the examples are well integrated into the existing content.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~27-~27: The preposition “to” seems more likely in this position.
Context: ...` Then add the following configuration in your Server: <<< @/tutorials/snippets/...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

[uncategorized] ~79-~79: Did you mean: “By default,”?
Context: ... | OpenAPI file name. By default openapi.json. ...

(BY_DEFAULT_COMMA)

🪛 markdownlint-cli2 (0.17.2)

13-13: Inline HTML
Element: Banner

(MD033, no-inline-html)

88-88: Bare URL used
null

(MD034, no-bare-urls)

96-96: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

112-112: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

175-175: Inline HTML
Element: GithubContributors

(MD033, no-inline-html)

179-179: Inline HTML
Element: GithubContributors

(MD033, no-inline-html)

docs/tutorials/scalar.md

Romakita · 2025-03-11T13:32:53Z

🎉 This PR is included in version 8.5.4 🎉

The release is available on:

v8.5.4
GitHub release

Your semantic-release bot 📦🚀

IvaDey added 2 commits March 11, 2025 12:49

fix(scalar): remove _integration prop as 'tsed' value is not supporte…

7a8e809

…d by the latest @scalar/api-reference

docs(scalar): document 'cdn' setting

d704b2b

coderabbitai bot reviewed Mar 11, 2025

View reviewed changes

docs/tutorials/scalar.md Outdated Show resolved Hide resolved

docs/tutorials/scalar.md Outdated Show resolved Hide resolved

coderabbitai bot reviewed Mar 11, 2025

View reviewed changes

docs/tutorials/scalar.md Outdated Show resolved Hide resolved

docs/tutorials/scalar.md Outdated Show resolved Hide resolved

docs(scalar): fix typo (TsED -> Ts.ED)

d6bc786

Romakita force-pushed the docs/scalar branch from 06e445c to d6bc786 Compare March 11, 2025 13:13

Romakita approved these changes Mar 11, 2025

View reviewed changes

Romakita merged commit e9efef0 into tsedio:production Mar 11, 2025
1 of 9 checks passed

Romakita added the released label Mar 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve scalar docs: document 'cdn' setting #3006

Improve scalar docs: document 'cdn' setting #3006

IvaDey commented Mar 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 11, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

Romakita commented Mar 11, 2025

Improve scalar docs: document 'cdn' setting #3006

Improve scalar docs: document 'cdn' setting #3006

Conversation

IvaDey commented Mar 11, 2025 • edited by coderabbitai bot Loading

Information

Summary by CodeRabbit

coderabbitai bot commented Mar 11, 2025 • edited Loading

Review failed

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

Romakita commented Mar 11, 2025

IvaDey commented Mar 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)