Create a Branch

The default branch for VRender is the develop branch. Whether it's for feature development, bug fixes, or documentation writing, please create a new branch and then merge it into the develop branch. Use the following code to create a branch:

// Create a documentation or demo branch
git checkout -b docs/add-funnel-demo

Find or Create an Issue

In principle, we require that every PR has a corresponding issue. Before starting development, please make sure there is a corresponding issue that has not been claimed.

Search for Documentation Issues

You can search for documentation-related issues using the following method:

is:open label:docs

Some features may be associated with the "doc" label, so you can further check if the issue is purely a documentation task.

Create a Documentation Issue

Click on "NEW ISSUE", open the issue selection page, and choose "Documentation Request".

Fill in the relevant information for the documentation issue you want to submit.

Claim an Issue

If you want to write or modify documentation, you can leave a message under the issue to claim it. An administrator will contact you, confirm, and then assign the issue to you.

For example:

Create or Modify Documentation

The location of VRender documentation and demos in the project is as follows:

Currently, the types of documentation are as follows:

examples: Element examples, corresponding to the site:

https://www.visactor.io/vrender/example

guide: Tutorials, corresponding to the site: https://www.visactor.io/vrender/guide/asd/VRender_Website_Guide

Find the corresponding location of the documentation for additions or modifications. It is important to note that some documentation also requires maintenance of the "menu.json" file.

This file corresponds to the final display location and name of the documentation on the site. For example:

Use Marscode AI Programming Assistant for Documentation Writing

Marscode AI Programming Assistant can provide comprehensive assistance throughout the documentation creation process.

If you have not installed Marscode AI Programming Assistant yet, please download it from this link: https://www.marscode.cn/home?utm_source=developer&utm_medium=oss&utm_campaign=visactor_a

In documentation writing, using the context command appropriately can enhance the accuracy of the content.

**⭐️ #Workspace**

Select global code in Workspace as context, and AI will automatically find relevant code context based on your query.

**⭐️ #Files**

Search and select files in the code repository as context.

**⭐️ #Code**

Search and select functions or classes in the code repository as context.

Here are examples of how to use Marscode AI Programming Assistant for documentation writing.

5.1 Provide Documentation Writing Ideas

Here, invoke #Workspace and ask for help in generating an outline for developer documentation.

5.2 Generate Project Structure Explanation

Here, invoke #Workspace and ask for help in generating a document explaining the project structure.

You can further inquire about subfolders for more detailed explanations.

5.3 Generate File or Code Explanations

5.3.1 Generate Code Explanations

When selecting a piece of code in a file, you can choose the Explain command from the floating menu, and Marscode will generate a detailed code explanation. You can then review and adapt it as needed.

You can also directly input the Explain command in the dialog box.

You can also use the #Code context mentioned earlier to combine Explain with your instructions for more detailed tasks.

5.3.2 Generate File-Specific Explanations

Explain can be used in conjunction with Context or Files commands to generate explanations for the entire file.

5.4 Generate Sample Code

To better explain principles and usage, it is often necessary to provide runnable demos. You can use the code generation capabilities of Marscode to generate sample code. However, it is important to verify the accuracy of the generated code as AI-generated code may not always be precise.

5.5 Content Retrieval

Typically, each Q&A session with Marscode will provide reference documents that can offer more context for further analysis.

You can also directly search for files:

5.6 Translate Documentation

VisActor's documentation needs to be provided in both Chinese and English, and Marscode can assist with translation.

Commit Code

After completing the documentation, push the code to your remote branch. For example:

git commit -a -m "docs: add custom funnel demo and related docs"

VisActor's commit messages follow the Conventional Commits specification:

<type>[optional scope]: <description>

Common type values include docs (documentation, log changes), feat (new feature), fix (bug fix), refactor (code refactoring), etc. Please choose accordingly based on the actual situation.

Before submitting the commit, we will perform commit lint checks. You can refer to the check rules for more details.

A common issue is when the upstream (@visactor/vrender) has new updates, which may cause conflicts when submitting a Pull Request. Therefore, before submitting, merge the commits from other developers with your own. Switch to the develop branch using the following code: