-
Notifications
You must be signed in to change notification settings - Fork 226
fix: docs dead links #1984
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: docs dead links #1984
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @wang1212, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on optimizing the documentation site by fixing numerous dead links across various API and guide pages. The changes primarily involve updating internal URL paths to ensure correct navigation and improve the overall user experience of the documentation. A minor update to the .gitignore file is also included, related to documentation build artifacts.
Highlights
- Documentation Link Refactoring: Standardized internal documentation links by removing language prefixes (
/zh/or/en/) and adjusting paths to reflect a new, unified structure (e.g.,examples/3d#force-3dchanged toexamples/3d/3d-basic/#force-3d). - Build Configuration Update: Added
serverandserver side render resultto thesite/.gitignorefile, likely to prevent these build artifacts from being tracked by version control.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively addresses numerous dead links throughout the documentation by updating paths and removing language prefixes. The changes are consistent and improve the overall quality of the documentation.
I've pointed out a few minor issues in site/docs/api/basic/display-object.en.md where some link anchors appear to be in Chinese, likely due to a copy-paste error. Correcting these will further enhance the clarity of the English documentation.
Also, it seems the changelog entries for English and Chinese in the pull request description are swapped.
* fix: docs dead links (#1984) * fix: docs dead links * fix: add /en prefix to english docs * feat: upgrade chrome extension to manifest v3 and react to v18 - Upgrade manifest version from v2 to v3 with updated permissions format - Migrate background scripts to service worker - Update content_security_policy and web_accessible_resources format - Replace browser_action with action - Upgrade react and react-dom from v16 to v18 in g-devtool - Update devtool UI to support React 18 createRoot API - Maintain backward compatibility with legacy versions - Update minimum chrome version requirement to 88 * feat: add GitHub workflow for bug report reproduction check - Add new GitHub Actions workflow 'bug-report-reproduction-check' - Automatically analyze new bug reports for reproduction steps - Use Mistral AI to check for complete reproduction information - Add friendly comment when reproduction details are missing - Only trigger for issues labeled as 'bug' - Add necessary permissions for issues and models access * fix(workflow): correct indentation in bug report reproduction workflow Fix the YAML indentation for the github-script action to properly format the comment response in the bug report workflow. * feat(workflow): add weekly issue summary automation - Add GitHub Actions workflow for generating weekly issue summaries - Include prompt template for issue summarization using gh-models - Schedule to run every Monday at 09:00 * feat(workflow): add monthly issue metrics automation - Add GitHub Actions workflow to generate monthly issue metrics reports - Schedule to run on the 1st day of each month - Use github/issue-metrics to track issue statistics - Automatically create an issue with the metrics report This will help track and visualize issue metrics over time.
* fix: docs dead links (#1984) * fix: docs dead links * fix: add /en prefix to english docs * feat: upgrade chrome extension to manifest v3 and react to v18 - Upgrade manifest version from v2 to v3 with updated permissions format - Migrate background scripts to service worker - Update content_security_policy and web_accessible_resources format - Replace browser_action with action - Upgrade react and react-dom from v16 to v18 in g-devtool - Update devtool UI to support React 18 createRoot API - Maintain backward compatibility with legacy versions - Update minimum chrome version requirement to 88 * feat: add GitHub workflow for bug report reproduction check - Add new GitHub Actions workflow 'bug-report-reproduction-check' - Automatically analyze new bug reports for reproduction steps - Use Mistral AI to check for complete reproduction information - Add friendly comment when reproduction details are missing - Only trigger for issues labeled as 'bug' - Add necessary permissions for issues and models access * feat: add benchmark suite for rendering performance comparison - Add benchmark infrastructure with TestCase and TestRunner base classes - Implement test cases for basic shapes (circle, rect, path, etc.) across multiple renderers - Support g-canvas, g-canvas-v4 and zrender rendering engines - Add UI components for test execution and result visualization - Include i18n support with Chinese and English translations - Set up build configuration with Vite and TypeScript * feat(benchmark): add collapsible insight panel in PerformanceChart - Add state to track insight panel expansion - Implement collapsible UI with smooth animations - Improve styling and layout of insight panel - Add expand/collapse toggle functionality - Enhance user experience with better visual feedback * chore(benchmark): add performance test results for basic shapes Add benchmark results for basic shapes rendering comparison between different engines including g-canvas and zrender. The results include execution duration and memory usage metrics. * feat(benchmark): enhance i18n support for failure rate display - Add new translation key 'highestFailureRate' for displaying failure rate in both English and Chinese - Refactor failure rate display to use i18n template - Improve code formatting in PerformanceChart component - Fix whitespace and indentation issues in TestRunner * chore: remove other file
* feat(benchmark): Add performance test suite and analysis panel (#1987) * fix: docs dead links (#1984) * fix: docs dead links * fix: add /en prefix to english docs * feat: upgrade chrome extension to manifest v3 and react to v18 - Upgrade manifest version from v2 to v3 with updated permissions format - Migrate background scripts to service worker - Update content_security_policy and web_accessible_resources format - Replace browser_action with action - Upgrade react and react-dom from v16 to v18 in g-devtool - Update devtool UI to support React 18 createRoot API - Maintain backward compatibility with legacy versions - Update minimum chrome version requirement to 88 * feat: add GitHub workflow for bug report reproduction check - Add new GitHub Actions workflow 'bug-report-reproduction-check' - Automatically analyze new bug reports for reproduction steps - Use Mistral AI to check for complete reproduction information - Add friendly comment when reproduction details are missing - Only trigger for issues labeled as 'bug' - Add necessary permissions for issues and models access * feat: add benchmark suite for rendering performance comparison - Add benchmark infrastructure with TestCase and TestRunner base classes - Implement test cases for basic shapes (circle, rect, path, etc.) across multiple renderers - Support g-canvas, g-canvas-v4 and zrender rendering engines - Add UI components for test execution and result visualization - Include i18n support with Chinese and English translations - Set up build configuration with Vite and TypeScript * feat(benchmark): add collapsible insight panel in PerformanceChart - Add state to track insight panel expansion - Implement collapsible UI with smooth animations - Improve styling and layout of insight panel - Add expand/collapse toggle functionality - Enhance user experience with better visual feedback * chore(benchmark): add performance test results for basic shapes Add benchmark results for basic shapes rendering comparison between different engines including g-canvas and zrender. The results include execution duration and memory usage metrics. * feat(benchmark): enhance i18n support for failure rate display - Add new translation key 'highestFailureRate' for displaying failure rate in both English and Chinese - Refactor failure rate display to use i18n template - Improve code formatting in PerformanceChart component - Fix whitespace and indentation issues in TestRunner * chore: remove other file * feat: Add native pan and zoom demo (#1994) * feat: add native pan and zoom demo Adds a new demo under `__tests__/demos/camera/` that showcases how to implement panning and zooming on the canvas using native DOM events. This is in response to the user request to add such a demo. An issue in the execution environment prevented the test suite from being run. A `commitlint` hook blocked all commands, including `pnpm test`. The changes are submitted without test verification due to this environmental constraint. * fix: use getContextService for container access in nativePanZoom demo --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: wang1212 <[email protected]> * feat: add script to fetch and display npm download stats for monorepo packages * chore: update test config and TypeScript settings - Add JSDoc link to jest.unit.config.js - Fix module name mapper path in jest.unit.config.js - Expand coverage collection to more packages - Update coverage reporters - Move isolatedModules to tsconfig.json * fix: fix loop index in tapable (#2003) * fix: fix loop index in SyncWaterfallHook and AsyncSeriesWaterfallHook - Fix loop index in SyncWaterfallHook to start from 1 instead of 0 since the first callback is already called - Apply the same fix to AsyncSeriesWaterfallHook for consistency - Add comprehensive unit tests for all tapable hook types * chore: fix code style * chore: fix code lint issue * chore: add changeset * Add basic shape benchmark cases for g-canvas-local engine (#2030) * test: Add basic shape benchmark cases for g-canvas-local engine * test: Add basic shape benchmark cases for g-canvas-local engine * Update benchmark/src/benchmarks/g-canvas-local/engine.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * feat(text): add text-decoration support for text elements (#2035) * feat(text): add text-decoration support for text elements * docs: update text decoration info * docs: fix typos * perf: element event batch triggering (#2005) * perf: element event batch triggering * chore: update test snapshot * chore: use Array.from to convert iterator for compatibility * chore: add changeset * Update __tests__/demos/perf/custom-event.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * perf: remove rBush logic from element picking mechanism (#2031) * perf: remove rBush logic from element picking mechanism * chore: fix lint error * chore: add changeset * chore: update test case * fix: the element picking range includes the element border * chore(release): bump version (#2004) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * perf(g-plugin-canvas-renderer): improve wavy text decoration with quadratic curves * Update __tests__/demos/event/hit-test.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
🤔 This is a ...
🔗 Related issue link
💡 Background and solution
📝 Changelog
☑️ Self Check before Merge