Use numbered lists

deep-foundation · Dec 16, 2023 · 2e9151f · 2e9151f
1 parent ee84ae1
commit 2e9151f
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 32 deletions.
diff --git a/freephoenix888/getting-started/getting-started.tex b/freephoenix888/getting-started/getting-started.tex
@@ -0,0 +1,13 @@
+\subsection{Getting Started}
+\subsubsection{Run Deep}
+\begin{itemize}
+  \item Go to \hyperref{https://github.com/deep-foundation/dev?tab=readme-ov-file#readme}{readme of dev monorepository}
+  \item Click on \hyperref{https://gitpod.io/#https://github.com/deep-foundation/dev}{gitpod button there} to create a new gitpod workspace with gitpod monorepository installed there. Note that gitpod can ask you to register/login
+  \item When gitpod workspace with dev monorepository is initialized click on the button "Ports" located on the bottom-right side of the screen and open 3007 by clicking on its url or by clicking on "Open Browser" button that looks like a globe
+  \item Now you have DeepCase opened. It is a visual interface for Deep. You can use it to create, update, delete, view, select, travel through links and much more
+\end{itemize}
+\subsubsection{Open DeepCase}
+\begin{itemize}
+  \item When gitpod workspace with dev monorepository is initialized click on the button "Ports" located on the bottom-right side of the screen and open 3007 by clicking on its url or by clicking on "Open Browser" button that looks like a globe
+  \item Now you have DeepCase opened. It is a visual interface for Deep. You can use it to create, update, delete, view, select, travel through links and much more
+\end{itemize}
diff --git a/freephoenix888/handlers-subsection/handlers-subsection.tex b/freephoenix888/handlers-subsection/handlers-subsection.tex
@@ -29,7 +29,7 @@ \subsubsection{Серверные обработчики баз данных и
 транзакция отменяется
 \subparagraph{Примеры}
 \paragraph{Создание обработчика с помощью редактора}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type} и
             \hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -63,11 +63,11 @@ \subsubsection{Серверные обработчики баз данных и
       \item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
             связи email на значение "test@deep"
       \item Созерцайте отсутствие ошибки
-    \end{itemize}
+    \end{enumerate}
 \href{https://youtu.be/fDgIqL0pzsg}{Видео-гайд}
 
 \paragraph{Создание обработчика с помощью связей}
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.Type.Description}{Type} и
         \hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -101,7 +101,7 @@ \subsubsection{Серверные обработчики баз данных и
   \item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
         связи email на значение "test@deep"
   \item Созерцайте отсутствие ошибки
-\end{itemize}
+\end{enumerate}
 
 \paragraph{Асинхронные обработчики}
 \subparagraph{Описание}
@@ -124,7 +124,7 @@ \subsubsection{Серверные обработчики баз данных и
 \subparagraph{Примеры:}
 \paragraph{Создание обработчика с помощью редактора}
 Заметка: создание обработчика с помощью редактора тоже порождает связи, как в примере с созданием обработчика используя связи
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type} и
             \hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -158,11 +158,11 @@ \subsubsection{Серверные обработчики баз данных и
       \item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
             связи email на значение "test@deep"
       \item Созерцайте отсутствие ошибки
-    \end{itemize}
+    \end{enumerate}
 \href{https://youtu.be/UFKOC1GT4nE}{Видео-гайд}
 
 \paragraph{Создание обработчика с помощью связей}
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.Type.Description}{Type} и
         \hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -202,7 +202,7 @@ \subsubsection{Серверные обработчики баз данных и
           асинхронного хендлера для связи email}
   \item Видим \hyperlink{Handlers.Async.Result}{результат асинхронного
           обработчика в виде связей}
-\end{itemize}
+\end{enumerate}
 
 \paragraph{Справочник}
 \subparagraph{Параметры обработчика}
@@ -233,7 +233,7 @@ \subsubsection{Серверные обработчики веб маршрута
 Серверные обработчики реализованы с помощью npm пакета express
 \paragraph{Примеры}
 \subparagraph{Обработчик, возвращающий "ok" в любом случае}
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
         кодом:
@@ -272,12 +272,12 @@ \subsubsection{Серверные обработчики веб маршрута
         нашего
         \hyperlink{Core.Router.Description}{Router} до нашего
         \hyperlink{Core.Port.Description}{Port}
-\end{itemize}
+\end{enumerate}
 
 \subparagraph{Обработчик, обрабатывающий входящий запрос}
 В данном примере обработчик будет проверять поле isOk в входящем запрос, если
 он true, то мы ответим строкой "ok", иначе "not ok"
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
         кодом:
@@ -323,7 +323,7 @@ \subsubsection{Серверные обработчики веб маршрута
         нашего
         \hyperlink{Core.Router.Description}{Router} до нашего
         \hyperlink{Core.Port.Description}{Port}
-\end{itemize}
+\end{enumerate}
 
 \paragraph{Параметры обработчика}
 
@@ -366,7 +366,7 @@ \subsubsection{Серверные обработчики порта}
 маршрут /healtz. В нашем случае мы будем обрабатывать порт 5000, следовательно
 наш маршрут будет выглядеть так: deep-foundation.com:5000/healtz (вместо
 deep-foundation.com используйте свой адрес, на котором находится deep)
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
         кодом:
@@ -391,7 +391,7 @@ \subsubsection{Серверные обработчики порта}
         deep-foundation.com используйте свой адрес, на котором находится
         deep) и
         увидите ответ "ok" % TODO: Точно ок?
-\end{itemize}
+\end{enumerate}
 
 \subsubsection{Серверные обработчики по расписанию}
 Серверные обработчики позволяют выполнять определенные действия по расписанию.
@@ -411,7 +411,7 @@ \subsubsection{Серверные обработчики по расписани
 * * 1 * * означает, что обработчик будет запускаться каждую минуту каждого часа
 первого числа каждого месяца каждого дня недели
 TODO: В разработке
-\begin{itemize}
+\begin{enumerate}
   \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
         \hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
         значением:
@@ -460,4 +460,4 @@ \subsubsection{Серверные обработчики по расписани
         \hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с текстом
         "Hi!",
         содержащаяся в пользователе admin
-\end{itemize}
+\end{enumerate}
diff --git a/freephoenix888/links-subsection/links-subsection.tex b/freephoenix888/links-subsection/links-subsection.tex
@@ -17,7 +17,7 @@ \subsubsection{Описание}
 
 \subsubsection{Примеры}
 \paragraph{Простой мессенджер}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -50,5 +50,5 @@ \subsubsection{Примеры}
             Reply от
             myMessage до myConversation и \hyperlink{FAQ.HowToSetName}{назовите} её
             myReply
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/1ihR5gZrw6M}{Видео-гайд}
diff --git a/freephoenix888/links-types-subsection/links-types-subsection.tex b/freephoenix888/links-types-subsection/links-types-subsection.tex
@@ -14,7 +14,7 @@ \subsubsection{Описание}
 
 \subsubsection{Примеры}
 \paragraph{Тип без начала и конца}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -23,9 +23,9 @@ \subsubsection{Примеры}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             MyNode
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без начала и конца}
-\end{itemize}
+\end{enumerate}
 \subparagraph{Тип с определёнными началом и концом}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -78,10 +78,10 @@ \subsubsection{Примеры}
             виде экземпляра MyNode2, следовательно вы не можете использовать
             экземпляр
             MyNode3 как конец
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/qKmDteKn3g8}{Видео-гайд}
 \subparagraph{Тип между Any и определённым концом}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -140,10 +140,10 @@ \subsubsection{Примеры}
             должен быть в виде экземпляра MyNode1, следовательно вы не можете
             использовать
             экземпляр MyNode2 как конец
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/XOVLeJfdqQM}{Видео-гайд}
 \subparagraph{Тип между определённым началом и концом Any}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -203,10 +203,10 @@ \subsubsection{Примеры}
             MyLink
             удовлетворено:
             начало - экземпляр MyNode1, конец - экземпляр любого типа
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/fUpXOe8vlsE}{Видео-гайд}
 \subparagraph{Тип между Any и Any}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Type.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -273,5 +273,5 @@ \subsubsection{Примеры}
             ошибку, потому что ограничение типа MyLink удовлетворено: начало -
             экземпляр
             любого типа, конец - экземпляр любого типа
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/PQObFIfhRMo}{Видео-гайд}
diff --git a/freephoenix888/main-content-section/main-content-section.tex b/freephoenix888/main-content-section/main-content-section.tex
@@ -1,6 +1,7 @@
 \section{Основная часть}
 
 
+% \input{../getting-started/getting-started.tex}
 \input{../links-subsection/links-subsection.tex}
 \input{../deepcase-subsection/deepcase-subsection.tex}
 \input{../links-types-subsection/links-types-subsection.tex}

diff --git a/...enix888/materialized-path-and-trees-subsection/materialized-path-and-trees-subsection.tex b/...enix888/materialized-path-and-trees-subsection/materialized-path-and-trees-subsection.tex
@@ -7,7 +7,7 @@ \subsubsection{Описание}
 Вы сами можете создавать деревья!
 \subsubsection{Примеры}
 \paragraph{Создание дерева}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Tree}{Tree} и \hyperlink{FAQ.HowToSetName}{назовите} её
             myTree
@@ -83,4 +83,4 @@ \subsubsection{Примеры}
             по дереву myTree
       \item Видим связи myNode2, myDownLink, myNode1
       \item Возвращаемся в предыдущее пространство
-\end{itemize}
+\end{enumerate}
diff --git a/freephoenix888/packages-subsection/packages-subsection.tex b/freephoenix888/packages-subsection/packages-subsection.tex
@@ -14,7 +14,7 @@ \subsubsection{Описание}
 А становится зависимым от пакета Б \\
 \subsubsection{Примеры}
 \paragraph{Создание и публикация пакета}
-\begin{itemize}
+\begin{enumerate}
       \item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
             \hyperlink{Core.Package.Description}{Type}
             \hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без начала и конца}
@@ -52,7 +52,7 @@ \subsubsection{Примеры}
             Traveller->Out->Publish
       \item \hyperlink{Handlers.Async.HowToGetResult}{Просмотрите результат
                   асинхронного обработчика для связи Publish}
-\end{itemize}
+\end{enumerate}
 \href{https://youtu.be/k6dKOrwDMco}{Видео-гайд}
 
 % Обработчики