Skip to content

Commit d87bee4

Browse files
Upgrade to docs.json (#60)
1 parent 1cbfb1d commit d87bee4

File tree

4 files changed

+343
-350
lines changed

4 files changed

+343
-350
lines changed

docs.json

Lines changed: 320 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,320 @@
1+
{
2+
"$schema": "https://mintlify.com/docs.json",
3+
"theme": "mint",
4+
"name": "Tilebox Docs",
5+
"colors": {
6+
"primary": "#f43f5e",
7+
"light": "#FAFAFA",
8+
"dark": "#09090b"
9+
},
10+
"favicon": "/favicon.svg",
11+
"navigation": {
12+
"tabs": [
13+
{
14+
"tab": "Documentation",
15+
"groups": [
16+
{
17+
"group": "Get Started",
18+
"pages": [
19+
"introduction",
20+
"quickstart",
21+
"console",
22+
"ai-assistance",
23+
"authentication"
24+
]
25+
},
26+
{
27+
"group": "Datasets",
28+
"pages": [
29+
"datasets/introduction",
30+
{
31+
"group": "Concepts",
32+
"icon": "circle-nodes",
33+
"pages": [
34+
"datasets/concepts/datasets",
35+
"datasets/concepts/collections"
36+
]
37+
},
38+
{
39+
"group": "Dataset Types",
40+
"icon": "puzzle",
41+
"pages": [
42+
"datasets/types/timeseries",
43+
"datasets/types/spatiotemporal"
44+
]
45+
},
46+
"datasets/query",
47+
"datasets/ingest",
48+
"datasets/delete",
49+
"datasets/open-data"
50+
]
51+
},
52+
{
53+
"group": "Storage",
54+
"pages": [
55+
"storage/clients"
56+
]
57+
},
58+
{
59+
"group": "Workflows",
60+
"pages": [
61+
"workflows/introduction",
62+
{
63+
"group": "Concepts",
64+
"icon": "circle-nodes",
65+
"pages": [
66+
"workflows/concepts/tasks",
67+
"workflows/concepts/jobs",
68+
"workflows/concepts/task-runners",
69+
"workflows/concepts/clusters"
70+
]
71+
},
72+
"workflows/caches",
73+
{
74+
"group": "Observability",
75+
"icon": "eye",
76+
"pages": [
77+
"workflows/observability/open-telemetry",
78+
"workflows/observability/tracing",
79+
"workflows/observability/logging"
80+
]
81+
},
82+
{
83+
"group": "Near-Real Time",
84+
"icon": "bolt",
85+
"pages": [
86+
"workflows/near-real-time/automations",
87+
"workflows/near-real-time/cron",
88+
"workflows/near-real-time/storage-events"
89+
]
90+
}
91+
]
92+
}
93+
]
94+
},
95+
{
96+
"tab": "User Guides",
97+
"groups": [
98+
{
99+
"group": "Datasets",
100+
"pages": [
101+
"guides/datasets/create",
102+
"guides/datasets/ingest",
103+
"guides/datasets/ingest-format"
104+
]
105+
},
106+
{
107+
"group": "Workflows",
108+
"pages": [
109+
"guides/workflows/multi-language"
110+
]
111+
}
112+
]
113+
},
114+
{
115+
"tab": "Languages & SDKs",
116+
"groups": [
117+
{
118+
"group": "Tilebox SDKs",
119+
"pages": [
120+
"sdks/introduction"
121+
]
122+
},
123+
{
124+
"group": "Python",
125+
"pages": [
126+
"sdks/python/install",
127+
"sdks/python/sample-notebooks",
128+
"sdks/python/xarray",
129+
"sdks/python/async",
130+
"sdks/python/geometries"
131+
]
132+
},
133+
{
134+
"group": "Go",
135+
"pages": [
136+
"sdks/go/install",
137+
"sdks/go/examples",
138+
"sdks/go/protobuf"
139+
]
140+
}
141+
]
142+
},
143+
{
144+
"tab": "API Reference",
145+
"groups": [
146+
{
147+
"group": "Python",
148+
"pages": [
149+
{
150+
"group": "tilebox.datasets",
151+
"pages": [
152+
"api-reference/python/tilebox.datasets/Client",
153+
"api-reference/python/tilebox.datasets/Client.datasets",
154+
"api-reference/python/tilebox.datasets/Client.dataset",
155+
"api-reference/python/tilebox.datasets/Dataset.collections",
156+
"api-reference/python/tilebox.datasets/Dataset.collection",
157+
"api-reference/python/tilebox.datasets/Dataset.create_collection",
158+
"api-reference/python/tilebox.datasets/Dataset.get_or_create_collection",
159+
"api-reference/python/tilebox.datasets/Collection.delete",
160+
"api-reference/python/tilebox.datasets/Collection.find",
161+
"api-reference/python/tilebox.datasets/Collection.info",
162+
"api-reference/python/tilebox.datasets/Collection.ingest",
163+
"api-reference/python/tilebox.datasets/Collection.load"
164+
]
165+
},
166+
{
167+
"group": "tilebox.workflows",
168+
"pages": [
169+
"api-reference/python/tilebox.workflows/Client",
170+
"api-reference/python/tilebox.workflows/Task",
171+
"api-reference/python/tilebox.workflows/Client.runner",
172+
"api-reference/python/tilebox.workflows/TaskRunner.run_all",
173+
"api-reference/python/tilebox.workflows/TaskRunner.run_forever",
174+
"api-reference/python/tilebox.workflows/ExecutionContext.submit_subtask",
175+
"api-reference/python/tilebox.workflows/ExecutionContext.job_cache",
176+
"api-reference/python/tilebox.workflows/ClusterClient.create",
177+
"api-reference/python/tilebox.workflows/ClusterClient.find",
178+
"api-reference/python/tilebox.workflows/ClusterClient.delete",
179+
"api-reference/python/tilebox.workflows/ClusterClient.all",
180+
"api-reference/python/tilebox.workflows/JobCache.group",
181+
"api-reference/python/tilebox.workflows/JobCache.__iter__",
182+
"api-reference/python/tilebox.workflows/JobClient.submit",
183+
"api-reference/python/tilebox.workflows/JobClient.find",
184+
"api-reference/python/tilebox.workflows/JobClient.retry",
185+
"api-reference/python/tilebox.workflows/JobClient.cancel",
186+
"api-reference/python/tilebox.workflows/JobClient.visualize",
187+
"api-reference/python/tilebox.workflows/JobClient.query"
188+
]
189+
}
190+
]
191+
},
192+
{
193+
"group": "Go",
194+
"pages": [
195+
{
196+
"group": "datasets",
197+
"pages": [
198+
"api-reference/go/datasets/Get",
199+
"api-reference/go/datasets/List",
200+
"api-reference/go/datasets/Collections.Create",
201+
"api-reference/go/datasets/Collections.Get",
202+
"api-reference/go/datasets/Collections.GetOrCreate",
203+
"api-reference/go/datasets/Collections.List",
204+
"api-reference/go/datasets/Datapoints.GetInto",
205+
"api-reference/go/datasets/Datapoints.Query",
206+
"api-reference/go/datasets/Datapoints.QueryInto",
207+
"api-reference/go/datasets/Datapoints.Ingest",
208+
"api-reference/go/datasets/Datapoints.Delete",
209+
"api-reference/go/datasets/Datapoints.DeleteIDs",
210+
"api-reference/go/datasets/CollectAs",
211+
"api-reference/go/datasets/Collect",
212+
"api-reference/go/datasets/As"
213+
]
214+
},
215+
{
216+
"group": "workflows",
217+
"pages": [
218+
"api-reference/go/workflows/Task",
219+
"api-reference/go/workflows/GetCurrentCluster",
220+
"api-reference/go/workflows/SubmitSubtask",
221+
"api-reference/go/workflows/SubmitSubtasks",
222+
"api-reference/go/workflows/WithTaskSpan",
223+
"api-reference/go/workflows/WithTaskSpanResult",
224+
"api-reference/go/workflows/NewTaskRunner",
225+
"api-reference/go/workflows/TaskRunner.GetRegisteredTask",
226+
"api-reference/go/workflows/TaskRunner.RegisterTasks",
227+
"api-reference/go/workflows/TaskRunner.Run",
228+
"api-reference/go/workflows/Clusters.Create",
229+
"api-reference/go/workflows/Clusters.Get",
230+
"api-reference/go/workflows/Clusters.Delete",
231+
"api-reference/go/workflows/Clusters.List",
232+
"api-reference/go/workflows/Jobs.Submit",
233+
"api-reference/go/workflows/Jobs.Get",
234+
"api-reference/go/workflows/Jobs.Retry",
235+
"api-reference/go/workflows/Jobs.Cancel",
236+
"api-reference/go/workflows/Jobs.Query",
237+
"api-reference/go/workflows/Collect"
238+
]
239+
}
240+
]
241+
}
242+
]
243+
},
244+
{
245+
"tab": "Changelog",
246+
"groups": [
247+
{
248+
"group": "Changelog",
249+
"pages": [
250+
"changelog"
251+
]
252+
}
253+
]
254+
}
255+
],
256+
"global": {
257+
"anchors": [
258+
{
259+
"anchor": "Console",
260+
"href": "https://console.tilebox.com",
261+
"icon": "terminal"
262+
},
263+
{
264+
"anchor": "Book a Demo",
265+
"href": "https://book.vimcal.com/p/lauracosta/tilebox-demo",
266+
"icon": "calendar"
267+
},
268+
{
269+
"anchor": "Discord",
270+
"href": "https://tilebox.com/discord",
271+
"icon": "discord"
272+
}
273+
]
274+
}
275+
},
276+
"styling": {
277+
"eyebrows": "section",
278+
"codeblocks": "system"
279+
},
280+
"logo": {
281+
"light": "/logo/light.svg",
282+
"dark": "/logo/dark.svg"
283+
},
284+
"contextual": {
285+
"options": [
286+
"copy",
287+
"view"
288+
]
289+
},
290+
"navbar": {
291+
"links": [
292+
{
293+
"label": "Website",
294+
"href": "https://tilebox.com"
295+
}
296+
],
297+
"primary": {
298+
"type": "button",
299+
"label": "Console",
300+
"href": "https://console.tilebox.com"
301+
}
302+
},
303+
"footer": {
304+
"socials": {
305+
"x": "https://x.com/tileboxio",
306+
"github": "https://github.com/tilebox",
307+
"linkedin": "https://www.linkedin.com/company/tilebox-io"
308+
}
309+
},
310+
"fonts": {
311+
"heading": {
312+
"family": "Poppins"
313+
}
314+
},
315+
"errors": {
316+
"404": {
317+
"redirect": false
318+
}
319+
}
320+
}

0 commit comments

Comments
 (0)