Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explain using refs in a config file #1364

Merged
merged 3 commits into from
Dec 21, 2023
Merged

docs: explain using refs in a config file #1364

merged 3 commits into from
Dec 21, 2023

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Dec 21, 2023

What/Why/How?

Added docs for $refs in the config file: #1345.

Merge this alongside the release.

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@tatomyr tatomyr requested a review from a team as a code owner December 21, 2023 10:25
Copy link

changeset-bot bot commented Dec 21, 2023

⚠️ No Changeset found

Latest commit: b184e74

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tatomyr tatomyr requested a review from a team December 21, 2023 10:25
@tatomyr tatomyr self-assigned this Dec 21, 2023
Copy link
Contributor

github-actions bot commented Dec 21, 2023

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.065 ± 0.045 1.022 1.156 1.00 ± 0.05
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.063 ± 0.017 1.041 1.085 1.00

Copy link
Contributor

github-actions bot commented Dec 21, 2023

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.31% 4100/5373
🟡 Branches 66.29% 2183/3293
🟡 Functions 68.42% 663/969
🟡 Lines 76.51% 3847/5028

Test suite run success

653 tests passing in 94 suites.

Report generated by 🧪jest coverage report action from b184e74

Copy link
Contributor

@HCloward HCloward left a comment

Choose a reason for hiding this comment

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

Made a couple of suggestions, otherwise looks good to me.

@tatomyr tatomyr force-pushed the docs/refs-in-cofing branch from f2ca470 to b184e74 Compare December 21, 2023 16:32
@tatomyr tatomyr merged commit 9930c3c into main Dec 21, 2023
29 checks passed
@tatomyr tatomyr deleted the docs/refs-in-cofing branch December 21, 2023 16:41
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