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

Smart Filters doc update #1296

Merged
merged 5 commits into from
Mar 11, 2025
Merged

Smart Filters doc update #1296

merged 5 commits into from
Mar 11, 2025

Conversation

AmoebaChant
Copy link
Contributor

No description provided.

@AmoebaChant AmoebaChant requested review from ryantrem and sebavan March 11, 2025 01:14
@bjsplat
Copy link

bjsplat commented Mar 11, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1296/merge

@bjsplat
Copy link

bjsplat commented Mar 11, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1296/merge

@RaananW RaananW requested a review from Copilot March 11, 2025 20:54

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces extensive documentation updates for Smart Filters, covering an in‐depth introduction, usage instructions, block creation guidelines, and an explanation of how Smart Filters work.

  • Added new markdown files detailing the introduction, usage, block creation, and inner workings of Smart Filters.
  • Updated the main Smart Filters overview to reference the new documentation topics.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
content/features/featuresDeepDive/smartFilters/introductionToSmartFilters.md New introduction document for Smart Filters
content/features/featuresDeepDive/smartFilters/howToUseSmartFilters.md Detailed instructions on how to use Smart Filters including sample code
content/features/featuresDeepDive/smartFilters/creatingBlocks.md Guide for creating custom blocks using annotated GLSL and TypeScript+GLSL code
content/toolsAndResources/sfe.md Documentation for the Smart Filter Editor tool (SFE)
content/features/featuresDeepDive/smartFilters/howSmartFiltersWork.md Explanation on how Smart Filters function and their optimizations
content/features/featuresDeepDive/smartFilters.md Updated overview with additional pointers to related topics
Comments suppressed due to low confidence (2)

content/toolsAndResources/sfe.md:4

  • The description is missing 'to' in 'Learn how use the Smart Filter'. Consider revising it to 'Learn how to use the Smart Filter Editor' for improved clarity.
description: Learn how use the Smart Filter

content/features/featuresDeepDive/smartFilters/howToUseSmartFilters.md:2

  • [nitpick] The title 'Introduction To Smart Filters' might be misleading given that the file focuses on usage instructions. Consider renaming it to 'How to Use Smart Filters' for better clarity.
title: Introduction To Smart Filters
@bjsplat
Copy link

bjsplat commented Mar 11, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1296/merge

@bjsplat
Copy link

bjsplat commented Mar 11, 2025

snapshot for this PR available at:

https://snapshots-cvgtc2eugrd3cgfd.z01.azurefd.net/DOCS/refs/pull/1296/merge

@AmoebaChant AmoebaChant merged commit d2e30a0 into master Mar 11, 2025
3 checks passed
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.

4 participants