Skip to content

Commit

Permalink
update | documentation | release notes | script and template (#23)
Browse files Browse the repository at this point in the history
* update | documentation | release notes | script and template

* update | documentation | release notes | header
  • Loading branch information
roman-right authored Apr 6, 2023
1 parent 1b34ef6 commit daea790
Show file tree
Hide file tree
Showing 18 changed files with 605 additions and 365 deletions.
11 changes: 10 additions & 1 deletion docs/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,18 @@
from docs_gen.project import build_project
from docs_gen.sort import build_sort
from docs_gen.update import build_update
from docs_gen.release_notes.notes_0_2 import build_0_2

connection = Connection.from_connection_string("annadb://localhost:10001")


def clean_collections():
collections = [connection["test"], connection["products"], connection["categories"]]
collections = [
connection["test"],
connection["products"],
connection["categories"],
connection["users"]
]
for collection in collections:
collection.delete().run()

Expand Down Expand Up @@ -55,3 +61,6 @@ def clean_collections():

clean_collections()
build_first_article(connection)

clean_collections()
build_0_2(connection)
54 changes: 27 additions & 27 deletions docs/build/articles/first.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/build/documentation/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_vector">ids</span>[
<span class="prefix_link">test</span>|<span class="value_link">b107e97b-6183-465d-b26e-4a1cc972edb7</span>|,
<span class="prefix_link">test</span>|<span class="value_link">d5776434-4d22-4f26-b7fa-1bdd85031fe9</span>|,
<span class="prefix_link">test</span>|<span class="value_link">c375058b-ce18-4e4d-ad7e-b3a531d8b362</span>|,
<span class="prefix_link">test</span>|<span class="value_link">fcdce77c-7f6c-4a3a-95c8-6278964e3864</span>|,
<span class="prefix_link">test</span>|<span class="value_link">03c70d0a-3ef0-4f78-baa1-558980a425a8</span>|,
<span class="prefix_link">test</span>|<span class="value_link">da51e160-9ef6-44d6-a716-af6a74f1e37c</span>|,
<span class="prefix_link">test</span>|<span class="value_link">63d7cb8c-39eb-438f-903c-de2310b2f04e</span>|,
<span class="prefix_link">test</span>|<span class="value_link">734c604a-c39f-468d-9836-4b70bc5050c4</span>|,
],
<span class="prefix_string">s</span>|<span class="value_string">meta</span>|:<span class="prefix_map">update_meta</span>{
<span class="prefix_string">s</span>|<span class="value_string">count</span>|:<span class="prefix_number">n</span>|<span class="value_number">4</span>|,
Expand Down
24 changes: 12 additions & 12 deletions docs/build/documentation/find.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,25 +54,25 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_map">objects</span>{
<span class="prefix_link">test</span>|<span class="value_link">45f3bdbf-909c-4cd9-bb2b-09745b2d4dce</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">07aa9909-63d2-4077-be88-5e61efc42f9b</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_7</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">7</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">95840eee-3872-4372-98a5-d52e06152271</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_8</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">8</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">43057373-8661-46c5-ae48-dd41cf0d58a5</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_9</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">9</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">01ca2c96-cdbe-4794-a222-3e4b5dc691a4</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">7</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_7</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">f9d12ac9-acd7-4d53-97fc-5f936ab5b463</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">de2519a1-6a93-41d1-a4b0-b53272c76235</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_6</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">6</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">1b7838a5-0d85-454e-92c4-856079eeec4f</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">5</span>|,
<span class="prefix_link">test</span>|<span class="value_link">468ce6b8-c91b-403c-b332-c255de1052ea</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_5</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">5</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">91d8eb62-b9fc-4667-8323-bb00840a30ba</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">9</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_9</span>|,
},
},
<span class="prefix_string">s</span>|<span class="value_string">meta</span>|:<span class="prefix_map">find_meta</span>{
Expand Down
8 changes: 4 additions & 4 deletions docs/build/documentation/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Get one or many objects by id (link)
## Examples

<pre><code><span class="prefix_primitive">collection</span>|<span class="value_primitive">test</span>|:<span class="prefix_vector">get</span>[
<span class="prefix_link">test</span>|<span class="value_link">43d0b05c-6cdc-400a-b13b-197f8b9e3f7c</span>|,
<span class="prefix_link">test</span>|<span class="value_link">1872cf34-150b-431d-9fd7-6b409325e9d8</span>|,
<span class="prefix_link">test</span>|<span class="value_link">716153f3-8761-4cb8-a9da-da490a109ce9</span>|,
<span class="prefix_link">test</span>|<span class="value_link">dff45aa0-6664-4597-ba81-1a3f5b455a18</span>|,
];
</code></pre>

Expand All @@ -23,8 +23,8 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_map">objects</span>{
<span class="prefix_link">test</span>|<span class="value_link">43d0b05c-6cdc-400a-b13b-197f8b9e3f7c</span>|:<span class="prefix_string">s</span>|<span class="value_string">foo</span>|,
<span class="prefix_link">test</span>|<span class="value_link">1872cf34-150b-431d-9fd7-6b409325e9d8</span>|:<span class="prefix_string">s</span>|<span class="value_string">bar</span>|,
<span class="prefix_link">test</span>|<span class="value_link">716153f3-8761-4cb8-a9da-da490a109ce9</span>|:<span class="prefix_string">s</span>|<span class="value_string">foo</span>|,
<span class="prefix_link">test</span>|<span class="value_link">dff45aa0-6664-4597-ba81-1a3f5b455a18</span>|:<span class="prefix_string">s</span>|<span class="value_string">bar</span>|,
},
<span class="prefix_string">s</span>|<span class="value_string">meta</span>|:<span class="prefix_map">get_meta</span>{
<span class="prefix_string">s</span>|<span class="value_string">count</span>|:<span class="prefix_number">n</span>|<span class="value_number">2</span>|,
Expand Down
10 changes: 5 additions & 5 deletions docs/build/documentation/insert.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_vector">ids</span>[
<span class="prefix_link">test</span>|<span class="value_link">52abe612-43b5-4010-9d8a-4f1206f867be</span>|,
<span class="prefix_link">test</span>|<span class="value_link">f1a5cd85-13cc-4f95-a8de-fab9323f0ab7</span>|,
<span class="prefix_link">test</span>|<span class="value_link">98b1984f-d2a6-42da-a7e7-2dcad00d94f1</span>|,
<span class="prefix_link">test</span>|<span class="value_link">9b6ae250-92f8-455d-a38d-13aacd047044</span>|,
<span class="prefix_link">test</span>|<span class="value_link">49e78d32-18c8-4202-ac94-4d70ca9c4b57</span>|,
<span class="prefix_link">test</span>|<span class="value_link">a62c0b4f-e4d0-4fbd-b851-63ceff038e86</span>|,
<span class="prefix_link">test</span>|<span class="value_link">6801db36-f54c-48eb-84cd-c496adfbdf45</span>|,
<span class="prefix_link">test</span>|<span class="value_link">a21fa468-19ef-4fed-bbbe-bfa94ae9d444</span>|,
<span class="prefix_link">test</span>|<span class="value_link">81650790-a378-4d19-a408-8a3f37eb37a9</span>|,
<span class="prefix_link">test</span>|<span class="value_link">65ccbacd-3c12-4737-b847-c60dc7fd9493</span>|,
],
<span class="prefix_string">s</span>|<span class="value_string">meta</span>|:<span class="prefix_map">insert_meta</span>{
<span class="prefix_string">s</span>|<span class="value_string">count</span>|:<span class="prefix_number">n</span>|<span class="value_number">5</span>|,
Expand Down
18 changes: 9 additions & 9 deletions docs/build/documentation/limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_map">objects</span>{
<span class="prefix_link">test</span>|<span class="value_link">1c24bd6c-fd2e-49ac-909e-ba541ee059b3</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_0</span>|,
<span class="prefix_link">test</span>|<span class="value_link">002c61ce-5518-48de-bbcb-913ab01d747f</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">0</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_0</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">7833ad51-398f-44cb-9910-9254775c6061</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_1</span>|,
<span class="prefix_link">test</span>|<span class="value_link">53ad7c5d-cfaf-4c64-bf6d-8096ba3596da</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">1</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_1</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">309eed41-f107-4f01-961a-167db9eb68f7</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">2</span>|,
<span class="prefix_link">test</span>|<span class="value_link">c60c1b7a-6982-4a9e-9381-4dc99366f2a7</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_2</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">2</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">b7e25544-3c54-4027-9940-e78676a87e6c</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">3</span>|,
<span class="prefix_link">test</span>|<span class="value_link">ef35ead4-850b-4648-a23f-a0d8e61a80f6</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_3</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">3</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">01c4a19b-13a3-4e55-a0ca-32ece285f941</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">c676587f-dbfe-4941-9cf2-14ece623c198</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_4</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">4</span>|,
},
Expand Down
12 changes: 6 additions & 6 deletions docs/build/documentation/offset.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ Output:
<pre><code><span class="prefix_primitive">result</span>:<span class="prefix_vector">ok</span>[
<span class="prefix_map">response</span>{
<span class="prefix_string">s</span>|<span class="value_string">data</span>|:<span class="prefix_map">objects</span>{
<span class="prefix_link">test</span>|<span class="value_link">467b7ef2-7d28-4c3b-9b97-72c8026e722c</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">95995636-7e16-4f3c-be4b-427f2f68b81a</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">5</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_5</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">c0fc2cf1-a4f1-49f4-b3d7-9a1ca92884ba</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">90a4b626-f6bf-4d26-a17b-6451324f381b</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_6</span>|,
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">6</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">944862ea-3f5a-4883-aeea-2b6cc49cc28a</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">6c158ae8-f5ec-4594-8645-a959e4b85307</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">7</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_7</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">b770d444-e4d4-42cf-88b9-df1f593dafdb</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_8</span>|,
<span class="prefix_link">test</span>|<span class="value_link">e0cbeaaf-7f5d-450b-871e-721b9bc63139</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">8</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_8</span>|,
},
<span class="prefix_link">test</span>|<span class="value_link">d14d3dae-d15e-4203-b44c-a4ed65ace979</span>|:<span class="prefix_map">m</span>{
<span class="prefix_link">test</span>|<span class="value_link">17644758-ac53-40d7-a609-6aeaeacc8164</span>|:<span class="prefix_map">m</span>{
<span class="prefix_string">s</span>|<span class="value_string">num</span>|:<span class="prefix_number">n</span>|<span class="value_number">9</span>|,
<span class="prefix_string">s</span>|<span class="value_string">name</span>|:<span class="prefix_string">s</span>|<span class="value_string">test_9</span>|,
},
Expand Down
Loading

0 comments on commit daea790

Please sign in to comment.