Skip to content

Update generated design docs#11490

Open
skiminki-nv wants to merge 5 commits into
shader-slang:masterfrom
skiminki-nv:2026-06-doc-update-1
Open

Update generated design docs#11490
skiminki-nv wants to merge 5 commits into
shader-slang:masterfrom
skiminki-nv:2026-06-doc-update-1

Conversation

@skiminki-nv
Copy link
Copy Markdown
Contributor

The design docs were updated against commit 5233902 .

Resolve the two findings deferred in the stage-3 remediation cycle:

- name-resolution/visibility.md F-002: add slang-check-overload.cpp to
  the doc's watched_paths so its TryCheckOverloadCandidateVisibility
  citation is properly tracked, then regenerate the doc. This flips it
  to review-stale for the next review cycle.
- target-pipelines/metal.md F-004: rebuild the Phase B diagram so every
  runtime conditional gate is a diamond node with true/false arms, per
  the target-pipeline diagram contract. Metal-constant gates are drawn
  as unconditional nodes per the filtered-branch convention.

Refresh freshness.json via mark-fresh for both docs.
Out-of-band Stage 2 review (gpt-5.5) of the rebuilt metal.md Phase B
diagram surfaced three major findings; remediate all three:

- F-001: add the minimal-optimization branch passes that were missing
  from Phase B (eliminateDeadCode under minimalOptimization && generics;
  applySparseConditionalConstantPropagation + eliminateDeadCode under
  minimalOptimization), with matching diagram nodes and table rows.
- F-002: redraw the shouldLegalizeExistentialAndResourceTypes false arm
  to run only the else-path legalizeEmptyTypes before rejoining.
- F-003: reorder the Phase C table so legalizeIRForMetal precedes
  floatNonUniformResourceIndex, legalizeLogicalAndOr, and
  legalizeImageSubscript, matching source and the diagram.

Records the review and remediation reports and updates the ledgers;
metal.md returns to remediated.
@skiminki-nv skiminki-nv requested a review from a team as a code owner June 5, 2026 17:05
@skiminki-nv skiminki-nv requested review from bmillsNV and removed request for a team June 5, 2026 17:05
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (145)
  • docs/generated/design/_meta/freshness.json is excluded by !**/generated/**
  • docs/generated/design/_meta/manifest.yaml is excluded by !**/generated/**
  • docs/generated/design/_meta/regenerate.py is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/architecture/dependency-graph.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/architecture/module-map.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/architecture/overview.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ast-reference/declarations.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ast-reference/expressions.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ast-reference/index.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ast-reference/modifiers.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ast-reference/statements.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/cross-cutting/core-module.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/cross-cutting/diagnostics.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/cross-cutting/ir-instructions.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/cross-cutting/targets.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/glossary.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/control-flow.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/decorations.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/differentiation.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/generics-and-existentials.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/index.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/metadata.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/misc.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/resources-and-atomics.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/structure.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/types.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/ir-reference/values.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/name-resolution/index.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/name-resolution/lookup.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/name-resolution/overload-resolution.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/name-resolution/scopes.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/name-resolution/visibility.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/01-lex-preprocess.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/02-parse-ast.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/03-semantic-check.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/04-ast-to-ir.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/04b-pre-link-passes.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/04c-layout-ir.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/05-ir-passes.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/06-emit.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/pipeline/overview.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/syntax-reference/grammar.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/syntax-reference/keywords-and-builtins.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/syntax-reference/tokens.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/cuda.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/hlsl.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/index.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/metal.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/spirv.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/remediations/target-pipelines/wgsl.md.remediation.md is excluded by !**/generated/**
  • docs/generated/design/_meta/review-state.json is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/architecture/dependency-graph.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/architecture/module-map.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/architecture/overview.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ast-reference/declarations.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ast-reference/expressions.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ast-reference/index.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ast-reference/modifiers.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ast-reference/statements.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/cross-cutting/core-module.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/cross-cutting/diagnostics.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/cross-cutting/ir-instructions.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/cross-cutting/targets.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/glossary.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/control-flow.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/decorations.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/differentiation.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/generics-and-existentials.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/index.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/metadata.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/misc.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/resources-and-atomics.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/structure.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/types.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/ir-reference/values.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/name-resolution/index.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/name-resolution/lookup.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/name-resolution/overload-resolution.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/name-resolution/scopes.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/name-resolution/visibility.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/01-lex-preprocess.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/02-parse-ast.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/03-semantic-check.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/04-ast-to-ir.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/04b-pre-link-passes.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/04c-layout-ir.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/05-ir-passes.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/06-emit.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/pipeline/overview.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/syntax-reference/grammar.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/syntax-reference/keywords-and-builtins.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/syntax-reference/tokens.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/cuda.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/hlsl.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/index.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/metal.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/spirv.md.review.md is excluded by !**/generated/**
  • docs/generated/design/_meta/reviews/target-pipelines/wgsl.md.review.md is excluded by !**/generated/**
  • docs/generated/design/architecture/dependency-graph.md is excluded by !**/generated/**
  • docs/generated/design/architecture/module-map.md is excluded by !**/generated/**
  • docs/generated/design/architecture/overview.md is excluded by !**/generated/**
  • docs/generated/design/ast-reference/declarations.md is excluded by !**/generated/**
  • docs/generated/design/ast-reference/expressions.md is excluded by !**/generated/**
  • docs/generated/design/ast-reference/index.md is excluded by !**/generated/**
  • docs/generated/design/ast-reference/modifiers.md is excluded by !**/generated/**
  • docs/generated/design/ast-reference/statements.md is excluded by !**/generated/**
  • docs/generated/design/cross-cutting/core-module.md is excluded by !**/generated/**
  • docs/generated/design/cross-cutting/diagnostics.md is excluded by !**/generated/**
  • docs/generated/design/cross-cutting/ir-instructions.md is excluded by !**/generated/**
  • docs/generated/design/cross-cutting/targets.md is excluded by !**/generated/**
  • docs/generated/design/glossary.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/control-flow.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/decorations.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/differentiation.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/generics-and-existentials.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/index.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/metadata.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/misc.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/resources-and-atomics.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/structure.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/types.md is excluded by !**/generated/**
  • docs/generated/design/ir-reference/values.md is excluded by !**/generated/**
  • docs/generated/design/name-resolution/index.md is excluded by !**/generated/**
  • docs/generated/design/name-resolution/lookup.md is excluded by !**/generated/**
  • docs/generated/design/name-resolution/overload-resolution.md is excluded by !**/generated/**
  • docs/generated/design/name-resolution/scopes.md is excluded by !**/generated/**
  • docs/generated/design/name-resolution/visibility.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/01-lex-preprocess.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/02-parse-ast.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/03-semantic-check.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/04-ast-to-ir.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/04b-pre-link-passes.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/04c-layout-ir.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/05-ir-passes.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/06-emit.md is excluded by !**/generated/**
  • docs/generated/design/pipeline/overview.md is excluded by !**/generated/**
  • docs/generated/design/syntax-reference/grammar.md is excluded by !**/generated/**
  • docs/generated/design/syntax-reference/keywords-and-builtins.md is excluded by !**/generated/**
  • docs/generated/design/syntax-reference/tokens.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/cuda.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/hlsl.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/index.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/metal.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/spirv.md is excluded by !**/generated/**
  • docs/generated/design/target-pipelines/wgsl.md is excluded by !**/generated/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 875f5837-dd08-4734-a4b3-b59dbf140483

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@skiminki-nv skiminki-nv added the pr: non-breaking PRs without breaking changes label Jun 5, 2026
Copy link
Copy Markdown
Contributor

@jvepsalainen-nv jvepsalainen-nv left a comment

Choose a reason for hiding this comment

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

LGTM

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

Labels

pr: non-breaking PRs without breaking changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants