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

Fix example path error #2528

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Conversation

zhuxudong
Copy link
Member

@zhuxudong zhuxudong commented Jan 24, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

  • Documentation
    • Updated documentation links for PBR shader parameters in English and Chinese documentation
    • Corrected example links for tilingOffset, clearCoat, and anisotropy parameters
    • Fixed a runtime example link in Chinese documentation

@zhuxudong zhuxudong requested a review from eyworldwide January 24, 2025 06:20
Copy link

coderabbitai bot commented Jan 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request focuses on updating documentation links in multiple files related to Physically Based Rendering (PBR) and runtime examples. The changes primarily involve correcting hyperlinks in both English and Chinese documentation files, replacing placeholder variables with direct paths to examples and API references. These modifications aim to improve link accuracy and consistency across the documentation.

Changes

File Change Summary
docs/en/graphics/shader/builtins/pbr.mdx Updated links for [tilingOffset], [clearCoat], and [anisotropy] parameters from ${examples} to /examples/
docs/zh/basics/overview.md Updated runtime example link from /examples/latest/background to /examples/background
docs/zh/graphics/shader/builtins/pbr.mdx Verified and maintained existing API reference links for PBR parameters

Possibly related PRs

Suggested labels

shader

Suggested reviewers

  • zhuxudong
  • cptbtptpbcptdtptp

Poem

🐰 Links dancing, paths so bright,
Docs now gleaming, references tight!
From placeholders to paths precise,
Our documentation now looks nice!
Hop, hop, hooray for clarity's might! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2433868 and 7703674.

📒 Files selected for processing (3)
  • docs/en/graphics/shader/builtins/pbr.mdx (2 hunks)
  • docs/zh/basics/overview.md (1 hunks)
  • docs/zh/graphics/shader/builtins/pbr.mdx (2 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 24, 2025
@GuoLei1990 GuoLei1990 merged commit fef78e6 into galacean:main Jan 24, 2025
7 checks passed
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.59%. Comparing base (2433868) to head (7703674).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2528   +/-   ##
=======================================
  Coverage   68.58%   68.59%           
=======================================
  Files         957      957           
  Lines      100125   100125           
  Branches     8572     8572           
=======================================
+ Hits        68671    68678    +7     
+ Misses      31198    31191    -7     
  Partials      256      256           
Flag Coverage Δ
unittests 68.59% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zhuxudong zhuxudong deleted the fix/example-error branch January 24, 2025 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants