worlds-documentation

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #android #linux #macos #nodejs #awesome #kubernetes #awesome-list #pytorch #openai #open-source

worlds-documentation

(★ 12)

No description available.

worlds-documentation Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**Looking for the home of MHCP Creator Made docs? Head to - https://mhcpcreators.github.io/worlds-documentation/**

# Adding Creator Made Documentation to GitHub

This document outlines the standard procedure for adding or updating documentation for this project. It involves forking the main repository, making changes in your fork, and then submitting a Pull Request to the main repository, all using the GitHub web interface.

When contributing documentation, please ensure your additions or edits fit into one of the existing high-level documentation folders/categories. If you are unsure where your contribution belongs, please discuss it with the project maintainers.

For a video tutorial on contributing to the repo:

[![How to Contribute to the MHCP GitHub](https://img.youtube.com/vi/V655i5sfxZQ/0.jpg)](https://youtu.be/V655i5sfxZQ)

## 1\. Prerequisites

* A GitHub account.  
* Familiarity with Markdown syntax.  
* A basic understanding of what forking a repository means.

## 2\. Procedure

The process of contributing documentation is broken down into two main phases:

1. **Initial Setup**: A one-time (or infrequent) process to prepare your environment by forking the repository.  
2. **Contribution Workflow**: The set of steps you'll follow each time you want to add or update documentation.

---

### 2.1. Initial Setup (One-time or Infrequent)

This section covers the steps you need to take once to set up your own copy (fork) of the main documentation repository.

[https://github.com/MHCPCreators/worlds-documentation](https://github.com/MHCPCreators/worlds-documentation)

#### 2.1.1. Fork the Repository

Forking creates your own copy of the project repository where you can make changes without affecting the original project.

1. Navigate to the main page of the **original (upstream)** repository on GitHub (this is the project you want to contribute to).  
2. In the top-right corner of the page, click the **"Fork"** button.  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image12.png)
3. If prompted (e.g., if you belong to multiple organizations), select your GitHub account as the destination for the fork.

4. You will be redirected to your newly created fork (e.g., `https://github.com/your-username/repository-name`). This is now your personal copy.

---

### 2.2. Contribution Workflow (For Each Documentation Change)

Once you have your fork set up, follow these steps for each new piece of documentation or update you wish to contribute.

#### 2.2.1. Add or Edit Documentation Files (in Your Fork)

On your main branch, add or edit documentation files. **Crucially, place your files in the correct category folder as detailed in the table below.** If you're unsure about the correct category, please consult with project maintainers before proceeding.

**Documentation Categories:**

| Category Folder Name (Example) | Description |
| :---- | :---- |
| `understanding-the-desktop-editor` | Covers installation, UI, world creation basics, debugging, and project settings. |
| `creating-a-world` | Focuses on preparation, tools, testing, and beginner tutorials for first-time world creation. |
| `generative-ai-tools` | Details on AI-powered tools for code, audio, texture, visual, and mesh generation. |
| `getting-started-with-scripting` | Introduces TypeScript scripting, setup, basic tutorials, and script management. |
| `scripting-concepts-persistence-apis` | Dives into advanced scripting, APIs, asset loading, and persistent data. |
| `meshes-materials-import` | Covers 3D model creation, material application, and custom model importing. |
| `lighting-colliders-audio` | Details lighting techniques, collider setup for interaction, and audio integration. |
| `gizmos` | Explores various gizmos for interaction, audio, and advanced world mechanics. |
| `asset-library-import` | Focuses on using the asset library, templates, and managing assets. |

1. Verify you are in **your forked repository** and on the branch created for these specific changes.  
2. To **add a new file**:

* Using the table above, identify the **appropriate category folder** for your new file (e.g., `docs/understanding-the-desktop-editor/`).  
   * Navigate to this folder. If it doesn't exist, GitHub allows you to create it when naming the file: simply type the desired folder path followed by your filename (e.g., `docs/new-category/your-file.md` will create the `new-category` folder if it's not present).  
   * Click the **"Add file"** button and select either **"Create new file"** or **"Upload files"**.  
     ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image8.png) 
   * If creating a new file:  
     * Enter the name for your file in the name field (e.g., `new-guide.md`).  
     * Write or paste your Markdown content into the editor.  
       ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image6.png) 
   * If uploading files:  
     * Drag and drop your file(s) or use the file chooser to select them.

3. To **edit an existing file**:  
   * Navigate to the file you want to edit within your fork.  
   * Click the **pencil icon** (which usually says "Edit this file") on the right side of the file view.  
   * Make your desired changes in the editor.  
     ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image1.png)

#### 2.2.2. Linking to YouTube Videos

**How to get the YouTube embed code:**

1. Go to the video  
2. Click Share  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image2.png)
3. Click Embed  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image11.png)
4. Copy and paste the Embed Video code to the File Editor in GitHub  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image5.png)

**Note:** No preview will be available because iframe is not supported in markdown. Please use the GitHub

#### 2.2.3. Commit Your Changes (in Your Fork)

Save your work by committing the changes to your branch in your fork.

1. After creating, uploading, or editing a file **in your fork**, press the **"Commit changes"** button.  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image9.png)
2. **Commit message:** Write a clear and concise commit message.  
   * The first line should be a short summary (max 50-72 characters is a good guideline), e.g., `docs: Add guide for Feature X`.  
   * If more detail is needed, leave a blank line after the summary and then provide a more detailed explanation in the larger text box.  
   * *Good commit message practice:* Start with a prefix indicating the type of change (e.g., `docs:`, `fix:`), followed by a concise description.  
3. Ensure the option **"Commit directly to the `main` branch"** is selected. This refers to the branch in your fork.  
4. Click the green **"Commit changes"** button.

#### 2.2.4. Create a Pull Request (PR) from Your Fork to the Original Repository

A Pull Request (PR) is how you propose your changes to the original project.

1. After committing your changes to your branch **in your fork**, navigate to the main page of **your forked repository** on GitHub.  
2. You should see a prominent notification bar for your recently pushed branch, often with a **"Contribute"** button. Click this button.  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image13.png)
3. If you don't see this prompt:  
   * Go to the **"Pull requests"** tab of **your forked repository** and click **"New pull request"**.  
     ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image4.png)
   * Alternatively, go to the **"Pull requests"** tab of the **original (upstream) repository** and click **"New pull request"**. You may then need to click "compare across forks".

4. You will be taken to the **"Open a pull request"** page. Carefully review the branches:  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image3.png) 
   * **Base repository:** This should be the **original (upstream) repository** you forked from (e.g., `original-owner/repository-name`).  
   * **Base branch:** This is the branch in the original repository you want your changes merged into (commonly `main` or `master`).  
   * **Head repository:** This should be **your fork** (e.g., `your-username/repository-name`).  
   * **Compare branch** (or **Head branch**): This should be the branch in your fork that contains your changes (e.g., `<your-branch-name>`).  
   * GitHub usually selects these correctly if you used the "Contribute" button from your fork. If not, use the dropdown menus to select the correct repositories and branches.  
5. **Title:** Write a clear and descriptive title for your PR. The main commit message is often a good starting point.  
   * Example: `docs: Video Gizmo Documentation`  
6. **Description:** In the text area, provide a summary of your changes.  
   * Explain the purpose of the documentation being added or updated.  
   * If fixing a reported issue, link to any relevant issues in the **original repository** (e.g., "Closes original-owner/repository-name\#123" to automatically close issue \#123 when the PR is merged).  
   * Clearly state that you've added or updated documentation.  
7. Click **"Create pull request"**. This submits your changes for review to the maintainers of the original repository.  
   ![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image7.png)

#### 2.2.5. Review Process

After submitting your PR, project maintainers will review your contribution.

1. Maintainers of the original repository will review your changes. They may ask questions, request modifications, or suggest improvements directly on the PR page using comments and review tools.  
2. Monitor your PR for feedback. You will typically receive notifications from GitHub.  
3. If changes are requested, address the feedback by making further edits and commits to your branch **in your forked repository**. New commits pushed to that branch in your fork will automatically update the existing Pull Request.

#### 2.2.6. Merging the Pull Request

Once your PR is approved and any automated checks pass, a maintainer will merge it.

1. After any necessary discussions and revisions, if the maintainers are satisfied, they will merge your PR into the `main` (or target) branch of the original repository.  
2. Your documentation changes are now part of the project\!

#### 2.2.7. Keep Fork Up-to-Date

Keeping your fork's main branch in sync with the upstream repository is also good practice for future contributions. Occasionally, press the "Sync Fork" button on **your forked repository's** main page to retrieve any updates to the **original (upstream) repository**.  
![](https://raw.githubusercontent.com/MHCPCreators/worlds-documentation/main/images/image10.png)

---

## 3\. Frequently Asked Questions (FAQ)

**Q: Do I upload my documentation as its own repository, or does it go into a topic-specific repository?**

A: All documentation contributions should be made to the **main project repository** by following the forking workflow outlined in this SOP. You do not need to create a separate repository for your documentation. Your changes will be integrated into the existing documentation structure within the main repository.

**Q: How should my documentation be tagged or categorized?**

A: Your documentation should be placed into the appropriate **category folder** within the `docs/` directory of the main repository. Please refer to the table in **Section 2.2.2. Add or Edit Documentation Files** for a list of predefined categories and their corresponding folder names (e.g., `docs/understanding-the-desktop-editor/`, `docs/creating-a-world/`). If you are unsure which category your contribution fits into, please consult with the project maintainers.

**Q: Do videos all go into a video repository, or are they part of some other structure?**

A: Videos themselves are typically hosted on platforms like YouTube. Within the documentation, you should **link to these videos** (either as a standard hyperlink or an embedded thumbnail link, as described in **Section 2.2.3**) directly within the relevant Markdown (`.md`) files. These Markdown files are organized into the category folders mentioned above. There is no separate video repository; links to videos become part of the documentation content within the existing structure.

---

By following these steps, you can contribute effectively to the project's documentation. Thank you for helping keep our documentation up-to-date and informative\!

worlds-documentation

worlds-documentation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

worlds-documentation

worlds-documentation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README