Doc update new UI 0.5.0
Problem to solve
The ui has been updated, the doc must also be updated. We have to take every part of the doc that includes an image of the old ui to change it + add/modify the new parts that come with the new ui (server passwords, preset system, ...)
Further details
Goal:
- to have an up-to-date document
- facilitate the transition of old users to multi-user 0.5.0
- bring new users and support them with the doc (+ do communication if possible)
Progress
Index:
-
First page
About Mutli-User:
-
The idea -
Key Features -
Community -
Discord -
Add contributors
-
Getting started:
-
Installing Multi-User -
Update the Addon -
Quick start -
How to join a session -
How to host a session -
How to manage a session -
Joining a server
User Interface:
-
Side Pannel -
Presence (+link images)
Advanced:
-
Advanced settings (+link images)
Hosting on Internet:
-
Hosting on the internet -
Change images to new ui -
Clean 'docs' file ("tutorials" and "hosting_internet")
-
Workflow: (postponed)
-
[ ] Worklow[ ] Lookdev[ ] Teaching[ ] Maybe other things...
Troubleshooting:
-
Troubleshooting
Ways to contribute:
-
Need to be update ?
Glossary: (removed / postponed ?)
[ ] To update (+link image)
Idea
Left pannel:
- Header
- Remove house icon
- Add logo (maye do another logo idk) + Title: "Multi-user v0.5.1 Doc"
- Getting started
- About Multi-user
- Introduction (new introduction to present the addon(What it is ? For who? Purpose? How it work? Keys words+purpose of the doc) + keep the old introduction to explain the philosophy behind real-time colab)
- *Multi-verse (if pertinant)
- The Multi-user Community
- Installing Multi-user
- System requirements
- Download Multi-user
- Install
- Auto-Updater (enlarge images)
- Quick Start
- Host a Session
- Join a Session
- Manage a session
- About Multi-user
- User Interface
- Advanced Settings
- Hosting on the internet
- Workflow
- Troubleshooting
- Glossary
Index: (similar to the one from Blender manual)
Links/References
Blender manual: https://docs.blender.org/manual/en/latest/index.html
Blender doc api: https://docs.blender.org/api/current/index.html
Blender addon Photogrammetry: https://blender-addon-photogrammetry-importer.readthedocs.io/en/latest/index.html
Blender addon Mixer: https://ubisoft-mixer.readthedocs.io/en/latest/index.html
Godot: https://docs.godotengine.org/en/stable/index.html
/cc @project-manager