Skip to content

[docs] docs: tighten imports reference#44804

Merged
pelikhan merged 1 commit into
mainfrom
docs/unbloat-imports-a5ee0b3e2f3614da
Jul 10, 2026
Merged

[docs] docs: tighten imports reference#44804
pelikhan merged 1 commit into
mainfrom
docs/unbloat-imports-a5ee0b3e2f3614da

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Prose-only copy-edit of docs/src/content/docs/reference/imports.md. No functional, structural, or schema changes.

Changes

File: docs/src/content/docs/reference/imports.md

Section Change
Shared Workflow Components Rewrote definition using colon structure; removed ### Common bundles subheading, folded bundling guidance into prose
Path Resolution intro Shortened sentence; active voice
Relative paths Condensed --dir description
Repo-root-relative paths Removed redundant for security qualifier; condensed stable-path explanation
Cross-repo imports pins tocan be for @ref description
Section references Shortened #SectionName and ? optional-import descriptions
MCP Gateway Settings Em-dash → semicolon; trimmed trailing phrase
Importing Top-level jobs: Minor reword of merge/execution-order sentence
safe-outputs.jobs Merged two sentences into one
Self-Contained Lock Files Merged two sentences; wheneverwhen ... would otherwise fail

Motivation

Tighten reference prose: shorter sentences, active voice, remove redundant qualifiers.

Testing

Documentation-only change; no code, configuration, or schema modified.

Generated by PR Description Updater for #44804 · 25.3 AIC · ⌖ 5.47 AIC · ⊞ 4.7K ·

@github-actions

Copy link
Copy Markdown
Contributor Author

Hey team 👋 — this automated doc-unbloat PR looks clean and ready for a quick review.

The Documentation Unbloat workflow trimmed docs/src/content/docs/reference/imports.md by ~1.8% in word count (2560 → 2515 words), condensing repetitive prose while keeping all examples, tables, and technical details intact. The diff is small (34 lines), focused on a single file, and the PR description clearly explains every change made.

No new dependencies, no functional code changes — this is a straightforward docs quality improvement. Looks good to merge! 🎉

Generated by ✅ Contribution Check · 98.6 AIC · ⌖ 13.6 AIC · ⊞ 6.2K ·

@pelikhan
pelikhan marked this pull request as ready for review July 10, 2026 18:24
Copilot AI review requested due to automatic review settings July 10, 2026 18:24
@pelikhan
pelikhan merged commit b134c66 into main Jul 10, 2026
5 checks passed
@pelikhan
pelikhan deleted the docs/unbloat-imports-a5ee0b3e2f3614da branch July 10, 2026 18:24
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Design Decision Gate 🏗️ completed the design decision gate check.

No ADR enforcement needed: PR does not have the 'implementation' label and has ≤100 new lines of code in business logic directories.

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

PR Code Quality Reviewer completed the code quality review.

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Condenses the imports reference while preserving its technical content and examples.

Changes:

  • Streamlines shared-component and path-resolution explanations.
  • Tightens wording for optional imports, imported jobs, MCP settings, and inlined imports.
Show a summary per file
File Description
docs/src/content/docs/reference/imports.md Removes repetitive prose throughout the imports reference.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Medium

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documentation-only PR. All edits tighten prose without dropping technical content, changing accuracy, or altering behavior descriptions. LGTM.

🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · 9.02 AIC · ⌖ 4.92 AIC · ⊞ 4.8K

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Skills-Based Review 🧠

Applied /grill-with-docs — approving this documentation tightening.

📋 Key Themes & Highlights

Positive Highlights

  • ✅ All examples, tables, and links preserved intact
  • ✅ Active voice replacements improve scannability
  • ✅ Removed the unnecessary ### Common bundles sub-heading without losing meaning
  • ✅ Inlined-imports and optional-import descriptions are cleaner

Minor Observation

Line 215 removes the phrase "for security" from the absolute-path rejection rationale:

before: "any other prefix is rejected at compile time for security"
after: "any other prefix is rejected at compile time"

The rationale (security) is worth keeping so readers understand why the constraint exists, not just that it does. Consider restoring it or rephrasing as "...is rejected at compile time as a security boundary.".

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · 18.9 AIC · ⌖ 5.24 AIC · ⊞ 6.6K
Comment /matt to run again

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documentation-only PR. All changed lines reviewed — technical accuracy is preserved across all rewordings. Two minor observations that don't block merge: (1) the "Common bundles" section removal reframes the guidance from describing a first-class feature to general authoring advice; worth verifying this matches intent, but it reads correctly. (2) Removing "for security" from the absolute-path restriction loses the rationale; mildly reduces discoverability but the constraint itself is still documented. No blocking issues.

🔎 Code quality review by PR Code Quality Reviewer · 12.3 AIC · ⌖ 4.29 AIC · ⊞ 5.4K
Comment /review to run again

@github-actions

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.82.8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation doc-unbloat documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants