Home

Welcome to the Multiplayer Technology Contributor Guide!

This repository provides documentation source code, including guides, glossary, tutorials, code samples, and more. Content is Open Source, allowing you to contribute documentation, FAQs, and tutorials with Unity writers and developers. The contribution wiki will expand as we grow!

Contacting Unity Docs

Join the MLAPI Discord and post in the Documentation channel. We can answer questions, review content, and help with requests for documentation (RFD).

Have feedback on a page? Enter an issue through GitHub or from webpages (located at the bottom of each page).

Contributing to Docs

Clone the repo

1. Fork and clone the repo using Git, GitHub Desktop, or other method.
2. Create a branch for your work.
3. Commit updates to your branch and submit a Pull Request (PR).
4. Unity developers, writers, and community members will review and provide feedback.

Write content

Edit existing markdown files or create new files for content:

• Markdown (.md) content files are in /docs
• Images (.png) are in /static/img
• Static downloadable files such as scripts can be saved in /static

See Working with Markdown to learn more about creating files, using Markdown formats, adding images, adding navigation, and more.

Submit PR

Submit a PR for the branch. PRs use a template allowing you to select the type of change, enter the purpose and changes for the PR, and a link or number for an issue/ticket. This helps Unity review and prioritize reviews.

When complete, all PRs are reviewed, managed, and merged by Unity Technical Writers. We will expand to include maintainers as we grow.

Labels for PRs and issues

Label	Description
enhancement	Site additions, plugins, development that aids in site generation, templates, and more
new content	New topic markdown files for content, requires navigation additions
update	Updates to existing content and files, typically does not require navigation updates
feedback	Feedback typically entered from the website "Log an issue" link from pages
enhancement	Site additions, plugins, development that aids in site generation, templates, and more
documentation	New content, updates, any issues that affect documentation
duplicate	Closed issue due to duplicate issues/tickets, make sure to link to the original
bug	Issues with content, the site, links, typos, etc
question	Some issues are simply questions on how things work or more information, if a question add this label
invalid, wontfix	Close the issue as unneeded, not verified, etc
help wanted, good first issue	Great issues for Community to claim and work on