Beamable Docs Repository

This project is s the unified repository for Beamable Docs. This include the following documentation branches

• "core" - Shared Beamable Concepts Documentation
• "unreal" - Unreal SDK Documentation
• "unity" - Unity SDK Documentation
• "internal" - Beamable Internal Documentation and Guides

Cloning and Installing Dependencies:

• Clone the main branch of this repo (make sure you have git-lfs installed).
• Install Python 3.12
• Run the setup.sh script in a bash terminal to install the dependencies.

Running the Docs:

• Go to the branch you want to run (e.g. core, unreal, unity).
• In a terminal run "mkdocs serve" in the root of the repo to start a local server.
• Open the Serve link in your browser http://127.0.0.1:8000/Docs/

Next Steps:

You will find more details about the process of editing, building and deploying documents in the "Internal" documentation in the website or in running the internal branch.