Skip to content

Commit 2e9151f

Browse files
Use numbered lists
1 parent ee84ae1 commit 2e9151f

File tree

7 files changed

+46
-32
lines changed

7 files changed

+46
-32
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
\subsection{Getting Started}
2+
\subsubsection{Run Deep}
3+
\begin{itemize}
4+
\item Go to \hyperref{https://github.com/deep-foundation/dev?tab=readme-ov-file#readme}{readme of dev monorepository}
5+
\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
6+
\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
7+
\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
8+
\end{itemize}
9+
\subsubsection{Open DeepCase}
10+
\begin{itemize}
11+
\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
12+
\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
13+
\end{itemize}

freephoenix888/handlers-subsection/handlers-subsection.tex

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ \subsubsection{Серверные обработчики баз данных и
2929
транзакция отменяется
3030
\subparagraph{Примеры}
3131
\paragraph{Создание обработчика с помощью редактора}
32-
\begin{itemize}
32+
\begin{enumerate}
3333
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
3434
\hyperlink{Core.Type.Description}{Type} и
3535
\hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -63,11 +63,11 @@ \subsubsection{Серверные обработчики баз данных и
6363
\item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
6464
связи email на значение "test@deep"
6565
\item Созерцайте отсутствие ошибки
66-
\end{itemize}
66+
\end{enumerate}
6767
\href{https://youtu.be/fDgIqL0pzsg}{Видео-гайд}
6868

6969
\paragraph{Создание обработчика с помощью связей}
70-
\begin{itemize}
70+
\begin{enumerate}
7171
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
7272
\hyperlink{Core.Type.Description}{Type} и
7373
\hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -101,7 +101,7 @@ \subsubsection{Серверные обработчики баз данных и
101101
\item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
102102
связи email на значение "test@deep"
103103
\item Созерцайте отсутствие ошибки
104-
\end{itemize}
104+
\end{enumerate}
105105

106106
\paragraph{Асинхронные обработчики}
107107
\subparagraph{Описание}
@@ -124,7 +124,7 @@ \subsubsection{Серверные обработчики баз данных и
124124
\subparagraph{Примеры:}
125125
\paragraph{Создание обработчика с помощью редактора}
126126
Заметка: создание обработчика с помощью редактора тоже порождает связи, как в примере с созданием обработчика используя связи
127-
\begin{itemize}
127+
\begin{enumerate}
128128
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
129129
\hyperlink{Core.Type.Description}{Type} и
130130
\hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -158,11 +158,11 @@ \subsubsection{Серверные обработчики баз данных и
158158
\item \hyperlink{DeepCase.UpdateLink.Description}{Обновите} значение
159159
связи email на значение "test@deep"
160160
\item Созерцайте отсутствие ошибки
161-
\end{itemize}
161+
\end{enumerate}
162162
\href{https://youtu.be/UFKOC1GT4nE}{Видео-гайд}
163163

164164
\paragraph{Создание обработчика с помощью связей}
165-
\begin{itemize}
165+
\begin{enumerate}
166166
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
167167
\hyperlink{Core.Type.Description}{Type} и
168168
\hyperlink{FAQ.HowToSetName}{назовите} её Email
@@ -202,7 +202,7 @@ \subsubsection{Серверные обработчики баз данных и
202202
асинхронного хендлера для связи email}
203203
\item Видим \hyperlink{Handlers.Async.Result}{результат асинхронного
204204
обработчика в виде связей}
205-
\end{itemize}
205+
\end{enumerate}
206206

207207
\paragraph{Справочник}
208208
\subparagraph{Параметры обработчика}
@@ -233,7 +233,7 @@ \subsubsection{Серверные обработчики веб маршрута
233233
Серверные обработчики реализованы с помощью npm пакета express
234234
\paragraph{Примеры}
235235
\subparagraph{Обработчик, возвращающий "ok" в любом случае}
236-
\begin{itemize}
236+
\begin{enumerate}
237237
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
238238
\hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
239239
кодом:
@@ -272,12 +272,12 @@ \subsubsection{Серверные обработчики веб маршрута
272272
нашего
273273
\hyperlink{Core.Router.Description}{Router} до нашего
274274
\hyperlink{Core.Port.Description}{Port}
275-
\end{itemize}
275+
\end{enumerate}
276276

277277
\subparagraph{Обработчик, обрабатывающий входящий запрос}
278278
В данном примере обработчик будет проверять поле isOk в входящем запрос, если
279279
он true, то мы ответим строкой "ok", иначе "not ok"
280-
\begin{itemize}
280+
\begin{enumerate}
281281
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
282282
\hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
283283
кодом:
@@ -323,7 +323,7 @@ \subsubsection{Серверные обработчики веб маршрута
323323
нашего
324324
\hyperlink{Core.Router.Description}{Router} до нашего
325325
\hyperlink{Core.Port.Description}{Port}
326-
\end{itemize}
326+
\end{enumerate}
327327

328328
\paragraph{Параметры обработчика}
329329

@@ -366,7 +366,7 @@ \subsubsection{Серверные обработчики порта}
366366
маршрут /healtz. В нашем случае мы будем обрабатывать порт 5000, следовательно
367367
наш маршрут будет выглядеть так: deep-foundation.com:5000/healtz (вместо
368368
deep-foundation.com используйте свой адрес, на котором находится deep)
369-
\begin{itemize}
369+
\begin{enumerate}
370370
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
371371
\hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
372372
кодом:
@@ -391,7 +391,7 @@ \subsubsection{Серверные обработчики порта}
391391
deep-foundation.com используйте свой адрес, на котором находится
392392
deep) и
393393
увидите ответ "ok" % TODO: Точно ок?
394-
\end{itemize}
394+
\end{enumerate}
395395

396396
\subsubsection{Серверные обработчики по расписанию}
397397
Серверные обработчики позволяют выполнять определенные действия по расписанию.
@@ -411,7 +411,7 @@ \subsubsection{Серверные обработчики по расписани
411411
* * 1 * * означает, что обработчик будет запускаться каждую минуту каждого часа
412412
первого числа каждого месяца каждого дня недели
413413
TODO: В разработке
414-
\begin{itemize}
414+
\begin{enumerate}
415415
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
416416
\hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с таким
417417
значением:
@@ -460,4 +460,4 @@ \subsubsection{Серверные обработчики по расписани
460460
\hyperlink{Core.SyncTextFile.Description}{SyncTextFile} с текстом
461461
"Hi!",
462462
содержащаяся в пользователе admin
463-
\end{itemize}
463+
\end{enumerate}

freephoenix888/links-subsection/links-subsection.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ \subsubsection{Описание}
1717

1818
\subsubsection{Примеры}
1919
\paragraph{Простой мессенджер}
20-
\begin{itemize}
20+
\begin{enumerate}
2121
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
2222
\hyperlink{Core.Type.Description}{Type}
2323
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -50,5 +50,5 @@ \subsubsection{Примеры}
5050
Reply от
5151
myMessage до myConversation и \hyperlink{FAQ.HowToSetName}{назовите} её
5252
myReply
53-
\end{itemize}
53+
\end{enumerate}
5454
\href{https://youtu.be/1ihR5gZrw6M}{Видео-гайд}

freephoenix888/links-types-subsection/links-types-subsection.tex

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ \subsubsection{Описание}
1414

1515
\subsubsection{Примеры}
1616
\paragraph{Тип без начала и конца}
17-
\begin{itemize}
17+
\begin{enumerate}
1818
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
1919
\hyperlink{Core.Type.Description}{Type}
2020
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -23,9 +23,9 @@ \subsubsection{Примеры}
2323
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
2424
MyNode
2525
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без начала и конца}
26-
\end{itemize}
26+
\end{enumerate}
2727
\subparagraph{Тип с определёнными началом и концом}
28-
\begin{itemize}
28+
\begin{enumerate}
2929
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
3030
\hyperlink{Core.Type.Description}{Type}
3131
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -78,10 +78,10 @@ \subsubsection{Примеры}
7878
виде экземпляра MyNode2, следовательно вы не можете использовать
7979
экземпляр
8080
MyNode3 как конец
81-
\end{itemize}
81+
\end{enumerate}
8282
\href{https://youtu.be/qKmDteKn3g8}{Видео-гайд}
8383
\subparagraph{Тип между Any и определённым концом}
84-
\begin{itemize}
84+
\begin{enumerate}
8585
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
8686
\hyperlink{Core.Type.Description}{Type}
8787
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -140,10 +140,10 @@ \subsubsection{Примеры}
140140
должен быть в виде экземпляра MyNode1, следовательно вы не можете
141141
использовать
142142
экземпляр MyNode2 как конец
143-
\end{itemize}
143+
\end{enumerate}
144144
\href{https://youtu.be/XOVLeJfdqQM}{Видео-гайд}
145145
\subparagraph{Тип между определённым началом и концом Any}
146-
\begin{itemize}
146+
\begin{enumerate}
147147
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
148148
\hyperlink{Core.Type.Description}{Type}
149149
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -203,10 +203,10 @@ \subsubsection{Примеры}
203203
MyLink
204204
удовлетворено:
205205
начало - экземпляр MyNode1, конец - экземпляр любого типа
206-
\end{itemize}
206+
\end{enumerate}
207207
\href{https://youtu.be/fUpXOe8vlsE}{Видео-гайд}
208208
\subparagraph{Тип между Any и Any}
209-
\begin{itemize}
209+
\begin{enumerate}
210210
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
211211
\hyperlink{Core.Type.Description}{Type}
212212
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без
@@ -273,5 +273,5 @@ \subsubsection{Примеры}
273273
ошибку, потому что ограничение типа MyLink удовлетворено: начало -
274274
экземпляр
275275
любого типа, конец - экземпляр любого типа
276-
\end{itemize}
276+
\end{enumerate}
277277
\href{https://youtu.be/PQObFIfhRMo}{Видео-гайд}

freephoenix888/main-content-section/main-content-section.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
\section{Основная часть}
22

33

4+
% \input{../getting-started/getting-started.tex}
45
\input{../links-subsection/links-subsection.tex}
56
\input{../deepcase-subsection/deepcase-subsection.tex}
67
\input{../links-types-subsection/links-types-subsection.tex}

freephoenix888/materialized-path-and-trees-subsection/materialized-path-and-trees-subsection.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ \subsubsection{Описание}
77
Вы сами можете создавать деревья!
88
\subsubsection{Примеры}
99
\paragraph{Создание дерева}
10-
\begin{itemize}
10+
\begin{enumerate}
1111
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
1212
\hyperlink{Tree}{Tree} и \hyperlink{FAQ.HowToSetName}{назовите} её
1313
myTree
@@ -83,4 +83,4 @@ \subsubsection{Примеры}
8383
по дереву myTree
8484
\item Видим связи myNode2, myDownLink, myNode1
8585
\item Возвращаемся в предыдущее пространство
86-
\end{itemize}
86+
\end{enumerate}

freephoenix888/packages-subsection/packages-subsection.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ \subsubsection{Описание}
1414
А становится зависимым от пакета Б \\
1515
\subsubsection{Примеры}
1616
\paragraph{Создание и публикация пакета}
17-
\begin{itemize}
17+
\begin{enumerate}
1818
\item \hyperlink{DeepCase.InsertLink.Description}{Вставьте} связь типа
1919
\hyperlink{Core.Package.Description}{Type}
2020
\hyperlink{FAQ.HowToInsertLinkWithoutFromAndTo}{без начала и конца}
@@ -52,7 +52,7 @@ \subsubsection{Примеры}
5252
Traveller->Out->Publish
5353
\item \hyperlink{Handlers.Async.HowToGetResult}{Просмотрите результат
5454
асинхронного обработчика для связи Publish}
55-
\end{itemize}
55+
\end{enumerate}
5656
\href{https://youtu.be/k6dKOrwDMco}{Видео-гайд}
5757

5858
% Обработчики

0 commit comments

Comments
 (0)