From 30af1869b389dff522ad2ade95d89bb8fbc0a2d0 Mon Sep 17 00:00:00 2001
From: iLLiCiTiT <jakub.trllo@gmail.com>
Date: Thu, 10 Jun 2021 18:07:26 +0200
Subject: [PATCH] added basic info about the tool

---
 openpype/tools/project_manager/__init__.py    | 21 +++++++++++++++++++
 .../project_manager/project_manager/window.py |  2 ++
 2 files changed, 23 insertions(+)

diff --git a/openpype/tools/project_manager/__init__.py b/openpype/tools/project_manager/__init__.py
index 62fa8af8aa..1c5bfdcbd5 100644
--- a/openpype/tools/project_manager/__init__.py
+++ b/openpype/tools/project_manager/__init__.py
@@ -1,3 +1,24 @@
+"""Project Manager tool
+
+Purpose of the tool is to be able create and modify hierarchy under project
+ready for OpenPype pipeline usage. Tool also give ability to create new
+projects.
+
+# Brief info
+Project hierarchy consist of two types "asset" and "task". Assets can be
+children of Project or other Asset. Task can be children of Asset.
+
+It is not possible to have duplicated Asset name across whole project.
+It is not possible to have duplicated Task name under one Asset.
+
+Asset can't be moved or renamed if has or it's children has published content.
+
+Deleted assets are not deleted from database but their type is changed to
+"archived_asset".
+
+Tool allows to modify Asset attributes like frame start/end, fps, etc.
+"""
+
 from .project_manager import (
     ProjectManagerWindow,
     main
diff --git a/openpype/tools/project_manager/project_manager/window.py b/openpype/tools/project_manager/project_manager/window.py
index a800214517..ea68b02bbd 100644
--- a/openpype/tools/project_manager/project_manager/window.py
+++ b/openpype/tools/project_manager/project_manager/window.py
@@ -16,6 +16,8 @@ from avalon.api import AvalonMongoDB
 
 
 class ProjectManagerWindow(QtWidgets.QWidget):
+    """Main widget of Project Manager tool."""
+
     def __init__(self, parent=None):
         super(ProjectManagerWindow, self).__init__(parent)