Site Guide
This document is mainly designed to help you better utilize the VRender site, enabling you to quickly access the content you are looking for on the site.
Quick Start
Getting Started
Firstly, you need to complete the VRender Getting Started section, which will guide you on how to set up and use the environment required for VRender, as well as how to build your first graphic application using VRender.
Understanding VRender
After completing the Getting Started section, you can delve deeper into understanding the various primitives and interactions supported by studying the Basic Tutorial section. Then, proceed to learn about creating animations in the Animation section, and enhancing your application's functionality through extensions and plugins in the Extensions and Plugins section.
Documentation
The documentation of VRender provides detailed information on features and configurations. Depending on your needs, you can refer to the following sections:
-
Tutorials: Introduces the basic concepts of VRender and various usage methods.
-
Options: Provides all the configuration options of VRender along with detailed explanations.
Examples
The examples page offers numerous practical application cases of VRender, ranging from simple primitives to complex animations and custom extensions. Each example provides detailed descriptions, key configuration information, and source code. You can also modify examples using the online editor and view the effects.
How to Use the Search Function
This site provides a powerful search function, allowing you to quickly find relevant usage information. Click on the search box at the top of the site, enter keywords, and you will see matching results in the dropdown list. Select the appropriate result to view the related content.
How to Ask Questions & Provide Suggestions
We are happy to assist you! If you encounter any issues while learning VRender, you can ask questions in the following ways:
-
Submit an issue on the GitHub repository: Visit VRender GitHub, provide a detailed description of the problem you are facing, and our team will respond and resolve it promptly.
-
Start a discussion on the GitHub repository: Visit VRender Discussion, where you are welcome to share your ideas and suggestions. Our team will respond and address them promptly.
How to Report Corrections
If you find any issues in the document examples or believe that certain parts can be improved, please let us know. You can report corrections to us in the following ways:
-
Submit a pull request on the GitHub repository: Correct the content and submit it, and a team member will review and merge it.
-
Submit an issue: Point out the issues in the document, and the team will verify and rectify them promptly.
Thank you for your assistance! We will continuously improve the documentation to provide a better learning experience for all VRender users.