Skip to content

docs: document limit and disable-resolvability-validation in subgraph check and publish#2674

Merged
JivusAyrus merged 2 commits intomainfrom
suvij/eng-9257-add-documentation-for-limit-option-for-subgraph-check-and
Mar 20, 2026
Merged

docs: document limit and disable-resolvability-validation in subgraph check and publish#2674
JivusAyrus merged 2 commits intomainfrom
suvij/eng-9257-add-documentation-for-limit-option-for-subgraph-check-and

Conversation

@JivusAyrus
Copy link
Copy Markdown
Member

@JivusAyrus JivusAyrus commented Mar 20, 2026

Summary by CodeRabbit

Documentation

  • Added --limit option to subgraph check and subgraph publish commands to control the number of displayed results per category (default: 50).
  • Added --disable-resolvability-validation option for troubleshooting federated graph resolvability validation.
  • Removed --suppress-warnings flag documentation.

Checklist

…ation options in subgraph check and publish commands
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 20, 2026

Walkthrough

This PR updates CLI documentation for the wgc subgraph commands by removing the --suppress-warnings flag description and documenting two new options: --disable-resolvability-validation (to disable federated graph node resolvability validation) and -l, --limit (to cap result entries per category, default 50).

Changes

Cohort / File(s) Summary
CLI subgraph command documentation
docs-website/cli/subgraph/check.mdx, docs-website/cli/subgraph/publish.mdx
Removed --suppress-warnings flag description from check command; added documentation for --disable-resolvability-validation and -l, --limit [number] options to both check and publish commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main changes: documenting the --limit and --disable-resolvability-validation options for subgraph check and publish commands, which aligns with the actual file modifications.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
📝 Coding Plan
  • Generate coding plan for human review comments

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

@JivusAyrus JivusAyrus changed the title docs: add documentation for --limit and --disable-resolvability-validation options in subgraph check and publish commands docs: add docs for --limit and --disable-resolvability-validation options in subgraph check and publish commands Mar 20, 2026
@JivusAyrus JivusAyrus changed the title docs: add docs for --limit and --disable-resolvability-validation options in subgraph check and publish commands docs: document limit and disable-resolvability-validation options in subgraph check and publish commands Mar 20, 2026
Copy link
Copy Markdown
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

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

LGTM

@JivusAyrus JivusAyrus changed the title docs: document limit and disable-resolvability-validation options in subgraph check and publish commands docs: document limit and disable-resolvability-validation in subgraph check and publish Mar 20, 2026
@JivusAyrus JivusAyrus merged commit 7bd2912 into main Mar 20, 2026
7 checks passed
@JivusAyrus JivusAyrus deleted the suvij/eng-9257-add-documentation-for-limit-option-for-subgraph-check-and branch March 20, 2026 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants