Skip to content

Commit e108901

Browse files
committed
Reorganize docs
1 parent 3ed10ab commit e108901

15 files changed

+13890
-32498
lines changed

docs/app/docusaurus.config.js

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const config = {
1010
title: "Jetify Docs",
1111
tagline: "Instant, easy, and predictable shells and containers",
1212
url: "https://www.jetify.com",
13-
baseUrl: "/",
13+
baseUrl: "/docs",
1414
onBrokenLinks: "throw",
1515
onBrokenMarkdownLinks: "warn",
1616
favicon: "img/favicon.ico",
@@ -38,11 +38,10 @@ const config = {
3838
/** @type {import('@docusaurus/preset-classic').Options} */
3939
({
4040
docs: {
41-
routeBasePath: "/devbox/docs",
41+
routeBasePath: "/devbox",
4242
sidebarPath: require.resolve("./sidebars.js"),
4343
// Please change this to your repo.
4444
// Remove this to remove the "edit this page" links.
45-
docItemComponent: "@theme/ApiItem",
4645
editUrl: "https://github.com/jetify-com/devbox/tree/main/docs/app/",
4746
},
4847
blog: false,
@@ -64,14 +63,23 @@ const config = {
6463
{
6564
id: "cloud",
6665
path: "cloud",
67-
routeBasePath: "/cloud/docs",
66+
routeBasePath: "cloud",
6867
sidebarPath: require.resolve("./cloud_sidebars.js"),
6968
},
69+
],[
70+
"@docusaurus/plugin-content-docs",
71+
{
72+
id: "nixhub",
73+
path: "nixhub",
74+
routeBasePath: "nixhub",
75+
sidebarPath: require.resolve("./nixhub_sidebars.js"),
76+
docItemComponent: "@theme/ApiItem"
77+
}
7078
],
7179
[
7280
"docusaurus-plugin-openapi-docs",
7381
{
74-
id: "api",
82+
id: "nixhub",
7583
docsPluginId: "classic",
7684
config: {
7785
nixhub: {
@@ -88,20 +96,26 @@ const config = {
8896
({
8997
navbar: {
9098
logo: {
91-
alt: "Devbox",
92-
src: "img/devbox_logo_light.svg",
93-
srcDark: "img/devbox_logo_dark.svg",
94-
href: "/devbox/docs",
99+
alt: "Jetify Docs",
100+
src: "img/jetify-docs-logo-light.svg",
101+
srcDark: "img/jetify-docs-logo-dark.svg",
102+
href: "devbox",
95103
},
96104
items: [
97105
{
98-
to: "cloud/docs",
106+
to: "devbox",
107+
label: "Devbox",
108+
className: "header-text-link",
109+
position: "left"
110+
},
111+
{
112+
to: "cloud",
99113
label: "Jetify Cloud",
100114
className: "header-text-link",
101115
position: "left",
102116
},
103117
{
104-
to: "/devbox/docs/nixhub",
118+
to: "nixhub",
105119
label: "NixHub API",
106120
className: "header-text-link",
107121
position: "left",
@@ -148,7 +162,7 @@ const config = {
148162
},
149163
{
150164
label: "Docs",
151-
to: "https://www.jetify.com/devbox/docs/",
165+
to: "https://www.jetify.com/docs/devbox",
152166
},
153167
],
154168
},

docs/app/docs/nixhub/get-a-package.api.mdx renamed to docs/app/nixhub/get-a-package.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide_title: true
77
hide_table_of_contents: true
88
api: eJztWGtr3EYU/SuDPiQ2bNYmmFAMpWxpG1JSOzgJpSRmdyTNWhNLGmUeu16M/3vOnRlppd1NI/cB/VAwWI+573OP7t37JBcm07KxUtXJefJSWCbrpdIVpyeMp8pZxplpRCaXMmMNz275jcAhdiHvmtsbM2XvCmmYqPNGydoyLazTtYHQr28vL5hKP4nMMltwyzJVWy7xbt+ELUSre4LXWelyWd9ASSmNZWoJtaXgRpgJa0puSRyXvM4ZpBtn4cbH+g/lmCmUK3PmjIDOvl9yyTZ4f1urtbdW80qQ4p5lf2DNcdgqVip1y1wzZa+CYC1ETs+N4DorGDxoxeAImVucrJ6fhLeLTkrV5SaKwg48FwhnJbSh0GGdb6PudGhhVLkSi+nHOpkkuGtUjciT8/vk+ekp/RsW7fIWxyi3orb0ljdNKTOf3ZNPho7cJyYrRMXpym4aAaFQFwgOdc3qQdm0aGAfekMxYslbn2Pp8ReKjijTjQ/Ux4Gjiy7/sNRo1QhtZQiF8t/zx1gNG3v+vPtKpQL+Cpee/CRWqbpLHiaJcVXF9ebbSmeEEm1Z7+mOflJXqEo0uJ47XY5z9P3Va0JIT89T5Eorn8pWHalGeQRKOk6rUUu75hroCVIHXG2bo6eQa803ByJv++kqingg99RNISOtqMwIrGxpITrAjiK0jwfY3rLFdA8GUWBcKtrGCUfaRETjEY3h3QRkU6WSILmWtuj5QmgCiRAmDVWrR26H+tKXixs7d02O7s3HOUoSzMoqklCbnjU3LOrp5wQmOlJ7RAk7maERXPIVlyVPS2Cl/tOCDmtB1DUuvqyQDaPj0Jyh9begjD7FYqxlWbKU3PAnFlxXL84WDJBb3H334hmuffTKjDNLznLPRWZjENNIqxXPLt8Gq69l7e6C0aBipOWlg0rUi2DVwAXKbZ+XgrKvRU2ZenH2LOd6LevFZPuk9O5MfDbm/RMxQ/PujHeZW3iYOivm8GFkqToZRjI7/EQopNvhtzzjNbmPD5L/4uGLbTki6sv5pqJ8wNHAwN5BZKeSdl5wM9I7OtnmsP26BCVhZPDI7oyifXxnbXvIW6Wbcebo5Dd1dtnw0AzjxSPa8jJIsCMxvZmitNBAFS5lSv9ysVoch9iI07edusPDAE90tMX2eGJ+ykDNSAH1v3dmyMYdX85Q1HaGiUOXID4MorlYclfaVsWRMw4o2NB9DCCKmL7fhoF1uQajTBm7xAvNlrKkGck4jE2UbZlqf4Cwg3SIUjUVRgxWCJ6DgSc7iYEIz3NJsfFyO+49/Ycmija8r1fL8/PofnO1/OyGzRZNbHsNHymlRcBuyHJPd6oU6lPvKf+9ED6dHhWtypD7nVLtQInMoCTj3D9AEoZdzK7YEfk9I8pfiWNf08gWdLkd7YfDT+okhnGOEi15Zqmj4IuVtiQvQqPgUe/Zm4h2f7D7wM0fM9qFo+2M4IHajbFm8Lkw/fGhZb3IdmACVfcZ4G/4MEDaXyaG6OcghVfds34OQ/qv4uJAL/H27NDq8CPPMQkCr8aeM1E1djOYk9iREbT+/UA33z8pLWjxyY1lENB0UuOxFdp3yNnp2b7+C2XZL8rVeahnK4B2/dD2a/gHbqPzXrFfej47qWnastqJsUvBwfXtNwdaTonXVryU+e4O4xURt+5tSLG6Dw/XkwReFwreJDfCj02eDRLacEhS6FUbk98VksLaxpyfxG1wmocPpCmwFSWkjvZfbylWLKwybPbmFdR1E3HyfHo6Pd2H15tXHhNBuV/MsAaHpZHu2sBy0WD5EnVG9EjZV8ZWvN4ypd/2OYtw2bVzv10p//9Z4L/3s0AEqRV39gSho3tQ4ripBnh+SAie17TIGku39/cpUvVelw8P9Dj0GoE2l4aYBvhe8tLstlsfCEdXsTGP2b/ShAejuhWbLU1A3tER30crzBHkOaK4po3dDxA+pCAzyzLR2J7U3k8jg+Z++fM7tPsXkAupZw==
99
sidebar_class_name: "get api-method"
10-
info_path: nixhub/nixhub-api
10+
info_path: devbox/nixhub/nixhub-api
1111
custom_edit_url: null
1212
---
1313

@@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
2020
import ResponseSamples from "@theme/ResponseSamples";
2121
import SchemaItem from "@theme/SchemaItem";
2222
import SchemaTabs from "@theme/SchemaTabs";
23-
import Markdown from "@theme/Markdown";
2423
import Heading from "@theme/Heading";
2524
import OperationTabs from "@theme/OperationTabs";
2625
import TabItem from "@theme/TabItem";
@@ -35,6 +34,7 @@ import TabItem from "@theme/TabItem";
3534
<MethodEndpoint
3635
method={"get"}
3736
path={"/pkg"}
37+
context={"endpoint"}
3838
>
3939

4040
</MethodEndpoint>
@@ -71,7 +71,7 @@ You should use this endpoint if you know the name of the package you want to loo
7171
<ul>
7272
<ParamsItem
7373
className={"paramsItem"}
74-
param={{"name":"name","in":"query","required":true,"description":"The name of the package you want to look up. Must be a valid Nixpkgs package name.","schema":{"type":"string"}}}
74+
param={{"name":"name","in":"query","required":true,"description":"The name of the package you want to look up. Must be a valid Nixpkgs package name.","schema":{"type":"string"},"enumDescriptions":[]}}
7575
>
7676

7777
</ParamsItem>
File renamed without changes.

docs/app/docs/nixhub/resolve-a-package-version.api.mdx renamed to docs/app/nixhub/resolve-a-package-version.api.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
id: resolve-a-package-version
33
title: "Resolve a Package Version"
4-
description: "Resolve a Package Version"
4+
description: "Resolve a Package Version. This endpoint resolves a package name + version string to the latest version of the package available in the Nixpkg repository. The response includes the Flake installable information for the package on each supported platform."
55
sidebar_label: "Resolve a Package Version"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJztWltr5DYU/ivCL5vAdCaEsJTQC1PaLktpEtJs+xBCRrbPjLWRJa8uzgxD/nvPkeS5ZpNp2L4ZAo5lnXO+c/08yMvMgG20smCz82V2enJClxJsYUTjhFbZeXb5RzbICq0cKEdPedNIUXB6Ovpsacsys0UFNaf/3KIBFNL5ZygcCm7rGisWnzADDZpGlULNmKsAF6yXjukp46zhxQOfhTUtPckO2U0lLMM/A84bBSXLF0FuMmpPR2FjCxMGqmy0UGS5MboB40R0TfEaNvBZZ9DwHr4bVEg7CQYp74C4ijv2yC1Lhsph9jTIWjBWxAC8rlZyB9axJLOvveYOg2jDg25TVMfQk1aU6LJQKVRfPOoKGKyva24Wr2MYM1tp49jG6o6XQd3COqjtAZlkUtiQriQSvdh0q+CK5YCgreNSInytBoxLjR49CleFvSU4LqTtkFwl0RAgVBd1D/eyybkpqvdn35XcPAr1HNrt/VPJH+A+IeG5hP0ypxwJNdWmDqXNFACF3OnOAUSE5dc5h7XAWVCL6ZiCAVUA4XwZB259PbSEZOrR4IWYr5UTEgpRtBmiQ03JEd0Wsv1gRWuH1CjtoFTs+sU+WY8RWERDjwKxYWInM8yizyehDvWjAnOYlbC1yzjOAW2F02ax51PydW19ggG5/CvaI7nXzf1nC0rMm4eZnUQT7WEOfRA0z1phN3oqKe6mlk8GOJqva9xfcVuhI09ohztn7hvuqsOs0XaRe0eNRl2kt5oujYhN86kPvd0t57VU6EcqN23Yr9Dmep6wSW7dvW9KHF7loXMOx4ITNWz3Cw3PpKfDeBFjHRIUSsi7xrvN2cON4YsXRs9llGBHMJwNB2yCGiZ4kSKnSwnt5DjmnBuMW4uThnqfYZNveR+mDWHFGU0DgFpIHDYG3zGcqxgK1Brh7xKYBG4xEWMMeFrEelCF9CUi6kRLmPJAflHFUVcteJ8cSCJ2E7dluVDcYJcPGbvEB4ZNhQQ7YNYXFU0oDIQJGyivGA6QuqmRc1kFvESOGewEhoZaWQryjcuEBpW/+0Zs2rn39WxRGRzeCV4JJMKtNkgm1hWGHKoNhJGRoryhO9ca86P2lP9TQQhnqIpOpU2EtZWqnVIiM5iSw+A/076WXYyv2RHhHiPDiRaOQ05TJ9O/2/Mryb3DWvBClphPJ6a8wKxl1L5OOOK6LDZKbOlu7WoNuaNTKZSf92zas2nPpj2b9mzas2nPpm9g0/n37+/736Y9m/Zs2rNpz6Y9m/Zs+g3YtP9p2pNpT6Y9mfZk2pNpT6ZvI9Ot1et4kn2dzv/T07PnvgDARfYLL9l1PHc+Z1A3bhEzfmQBu479TDc//tBy6eEnhttwCDfc4KIDE7J9dnK2r/lCO/a79qoMTqwEsPRuu9qLF+xT2h8UZzSxv3hhaFI54+HQU/yF9jiesCswF+kgf8j+9DhicupRBC/K1bDqhEgRzYm9TxxSwhH4Cmr3QcBzgHbO9A+A9prTX0d0twsgJRud7E7Y/15BxYhXGpVmMwjvMaErs+6TCvIcTNvlxBuJDyvnGns+Glmgg4NhGYnEVqP2NCPj9HoVcKVaw5ji+wMbX33MNr6ayE6HJ8OT/al/9TF0W1ROseKqTEEJX0MkD0poQJX42kKjiqpHW1dztZ5aL3q9ZXMVQQdzN0J2wLijxuDsMkXkNusigg5WaIuWlsscp/4nI5+eaDlmiuJUCkuDFsM65dLuVuhy/T1NdnSd0nrM/pe6fdazB1isOys0Ld5mVMlvBv6m+n4B3LqX1vju6MaI+F5/e4d7I7+FkEexcVFA4zak9j5XIi2rmv/w2w32y7+Tk/jt
8+
api: eJztWm1v2zYQ/iuEvjTFPDsIgmII9gIPW4tiWBOk7fahK2JaOkdsZFElKSeGkf++50jKkuy08YLum4AAjsnjvT1398gQN0lGNjWqckqXyVlySVYXKxJSXMj0Rl6T+IuMxd5YvMuVFVRmlValEyYIWkhWUbKUSxLfiVU4IKwzqrwWTguXkyikI+u2m3rhV5ujciVVIecFCVX6jTfqrrq5hpVKW+W0WY8FHCA2W+nSslxa1PDdS78s5A0vWSeLRs1Cm6XkqAT+6xnDEsk0F7auKm0cZaKCdyw//qdMRkljwyZnm+Tk+Jg/+lk6/wNiqS4dlY53ZVUVKvXWJp8si2wSm+a0lPyfW1eEQ3r+iVKHg31dUyTD73CwMA2VPm0h2LpwnKs2yT7vtWsRwZ8hV5sScczX/txssjqZRIBmW8hguTK6IuNUCI3x6vgX8Nrzj7Pukd2BzOXSiVtpm0rIxsn9KIn4HqZ2pyb2tAM/JDFAvFNViGSlMoQc68XQ5xq6vA+2Xi6lWT/uw1TYHAUgOqs7UXp1a+toaQ9AUhTKerjikRBFN6xUlmK+rVS4r8uRkIVGRLfK5V42I4dmsI0nF23VenVB93gPTSlNmr84/T6T5laVD3nbl19wz1x1ema/zBmjbiOVRJxydHQ8Bo9Qftsm5mHg1QKOBRkqU2I/v+4HRB9PLXuyqGEQc6FV3syWYNNnh5tSwrueZ/vJCtYOqVGWYCh24xLvbY0MrIOhWwXfAOzsGijW85mvQ31bkjnMihdtEG+H3l5MMdbW+gwJOX8b7PG5x839ZwulH8V2FkysDgvoleJ5tlLdYR8VN1OrjgYkzC+XkM+lzRHIPexI58xVJV1+mDUWV/PacaNxF+le08UR0TUf+7C2u+XcnvL9yOUG9viNVnN9F30rpHVXdZVheGWHzjmMBaeW1O8XHp5RT5/2rAfIl1Dtqtp1Z480Rq6/MnrOwwlxROPr8UjMoGGGj0LN+SOj1ex5wFyaLu0+wJHB14YZYVIdNgafCcxVpAJag/u7BFaQtABiioTHRdvQOeTi0YwW0pNfUHHUVAu+xwB6TwBbRXNVSoMux/PCOTaMWKiC7AhkD8ZHwpEI4wUYV6SDCl0twbkiJ5mBY0Y7ieGhlmWKY5NF9AbKn30jNm3C+zJaXAaHd0JdKhBhrw2iibbCwKHakB8ZMcsd3XOtgU+5p/zvnHw6fVU0Km0krB5UO6XEZgDJYe4/0L5WvJleiiP2ewqGUyt67jGNncz/9udXPPcMtVCrIgOeTi1kCtQSbl+nHHNdEholtHSzdtG63NBpocr6bmDTgU0HNh3YdGDTgU0HNn0Cm9798OJq+G06sOnApgObDmw6sOnApt+ATYefpgOZDmQ6kOlApgOZDmT6NDLtrcbLD5fx/X/cPX3oBgAWxa8yE5fhvfOZoGXl1gHxI0voOvELf/npx5UsavpZQAxDuJIGi46MR/v0+HRf8xvtxEtdl5kPYnsApfehqb3wgT5lea/Y31r4XCvDk8qZmg59i7/WNcYTugJYxBf5Y/FnjREz5x6F8yrbDqvuRQ+eE3tXHCLgcHzranMh4CGHdt7pH+DaY0F/2aOPowR5zDVEk2vyTye+15LmogTHQ2bVZLo2BTZz5yp7NplY4tcB4yzQg80nq5OEVfJDk7cWKwiZwlOBmF68Tjp3IZKT8fH4eH+WX7z2PRSUcwZkmcVQ/R2HmIiMKiozPIzwAOKa0NYtZdnOoi/f2tm1uWlvrQxXfdonVkd3boId1Bby66HfxPr4kDT1AbhzZJ6XNps5mO29Ke7veTlUI1dNpiz7hCJbyMLudmE3+0eXsXSfi/+lNx+M7IbW7fTwgwlfE+7WJzv+pB7+inPtvGj9+8hfjAq/XT58hGzgcJ/ycGyaplS5zqm9K1m9CfDq93eYCf8CWKOwnA==
99
sidebar_class_name: "get api-method"
10-
info_path: nixhub/nixhub-api
10+
info_path: devbox/nixhub/nixhub-api
1111
custom_edit_url: null
1212
---
1313

@@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
2020
import ResponseSamples from "@theme/ResponseSamples";
2121
import SchemaItem from "@theme/SchemaItem";
2222
import SchemaTabs from "@theme/SchemaTabs";
23-
import Markdown from "@theme/Markdown";
2423
import Heading from "@theme/Heading";
2524
import OperationTabs from "@theme/OperationTabs";
2625
import TabItem from "@theme/TabItem";
@@ -35,13 +34,15 @@ import TabItem from "@theme/TabItem";
3534
<MethodEndpoint
3635
method={"get"}
3736
path={"/resolve"}
37+
context={"endpoint"}
3838
>
3939

4040
</MethodEndpoint>
4141

4242

4343

44-
Resolve a Package Version. This endpoint resolves a package name + version string to the latest version of the package available in the Nixpkg repository. The response includes the Flake installable information for the package on each supported platform.
44+
Resolve a Package Version. This endpoint resolves a package name + version string to the latest version of the package available in the Nixpkg repository. The response includes the Flake installable information for the package on each supported platform.
45+
4546

4647
<Heading
4748
id={"request"}
@@ -69,12 +70,12 @@ Resolve a Package Version. This endpoint resolves a package name + version strin
6970
<ul>
7071
<ParamsItem
7172
className={"paramsItem"}
72-
param={{"name":"name","in":"query","required":true,"description":"The name of the package you want to resolve. Must be a valid Nixpkgs package name.","schema":{"type":"string"}}}
73+
param={{"name":"name","in":"query","required":true,"description":"The name of the package you want to resolve. Must be a valid Nixpkgs package name.","schema":{"type":"string"},"enumDescriptions":[]}}
7374
>
7475

7576
</ParamsItem><ParamsItem
7677
className={"paramsItem"}
77-
param={{"name":"version","description":"The version string of the package you want to resolve.","in":"query","required":true,"schema":{"type":"string"}}}
78+
param={{"name":"version","description":"The version string of the package you want to resolve.","in":"query","required":true,"schema":{"type":"string"},"enumDescriptions":[]}}
7879
>
7980

8081
</ParamsItem>

docs/app/docs/nixhub/search-packages.api.mdx renamed to docs/app/nixhub/search-packages.api.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
id: search-packages
33
title: "Search Packages"
4-
description: "Search Packages"
4+
description: "Search Packages. This endpoint allows you to search for packages in the Nixpkgs repository using a search query. The response includes a list of package names along with their description. To get available versions and installables for a package, you can use this name with the `/v2/pkg` endpoint."
55
sidebar_label: "Search Packages"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJyNVe9LIzEQ/VdCPilIW8RP5X7Qg7tDDjxR75OIZnen3Wg2SZPZaln6v99MdlvXbu8oCLWZzHtv5k2mjQwQvbMRopw28nwy4Y8CYh60R+2snMrfv+SZzJ1FsMhR5b3RueLo+DnylUbGvIRK8X+49kBJLnuGHCnxI9bMijYiAniiJkhtFwJLoINYG4zCzYUSEVTIS7GsIaxH4q7UUdBfAKyDhUJk65TyNF6dj9urTwJs4Z22zOmD8xBQt0UlkJ60iIE4B9LuCLBPK1icQPcfps2ZRIfKPHbaeyQUhgWEgywpR9i6yiBwudvK5y4ksr4K5hiiqxDUethcYXRERrxNCDcdLpYKRaWQMBm+39QEJF61MSIDAZXHtdBzYd1O1CsEIGW1LUZEqBGqeITNIlKLza6UFqwnBOK+yQPbrKrgONf4JlfNxXmVv6gF9KmKg02NdVWpY+aCaildQNE73SNjOKMiPta+UAjFcao5Q6CuWCs5sRX+qqLocIS2ieZKv/mXBY+/d3LDQ6fRMHrfZgociqS3zTEKXhx63d9UIW6A2hJx2g3Ah1dwEgHJq6/Lz5/SwZfu3KtAbUcIpzJBXwyhrxyKHzw5SfQugdy939orlzxUfLk1hod9WevATcRQw37jbvdGZrB3uoZvNg//SL1u+xwpmdSUjojkAtLWUFjSl+6ZMziE1VZuHQzFSkQfp+PuyqiAVebeRrGk7SCZUdu5S2I6G8i5ss7E7PqS4BirlXI+mowmw0G7vkwroAXntahswU/HmRV/205IAZ42ENicHwo31kWslH1/MwdK/cC0axbCG469UWQA4aQSm64N97JrA1VVEgGfNE2mIvwJZrPh426vUnMKHVVm2LO5MnHftOb9x0Oe3HT2nop9Kw9qeoF1NyQrZWqOpz6vVNDMSOwPdKsEVdCuZSltwizPwWMva/CbxSg7/39+v6OJ+QsKVnKG
8+
api: eJztVU1v2zAM/SuETx1QJEXRU7EPdMA2FAO6ottO3bApNhOrlSVVotMGQf77SFlOHScDuvtObUzxvUfyUVoXFcYyaE/a2eK8+IoqlDVcq/JeLTBO4FutI6CtvNOWQBnjHiOsXAvkIHaH5y6AzwmgLVCNcKWf/P0iQkDvoiYXVtBGbReg+qyHFsNqAkyAfCp6ZyNydmlaVsTHjI4Ebt4jg1WNfDeOQR411UKjAwzks1gHC2SVS6WNmhmEJYbIEc6zFYNH4gIkEJNo1YMfp4pKZVkkMjCXLHRbHvg9XZ5OuaDf21ZM4IctjoteeSzO18XpyYn82e3ol898rHSW0JJElfdGl0qi07soR9ZFLGtslPxHK4+c5GZ3WBIn7mJdWOgi0lemZkjpKXUtbA1F6di4xWmEWmZBbbBYwWz1XFR39Lku5vTBeQyku6ISyEBapMCce9JkjENaEHFikr8zbY4LcjyRX1n7gITDuMBwkCXlgG2bGQYpt69cJkojFcKxj65CUKv95m4t1y3BTcalWhE0isrOCsOmJiB2iTEwQ8DG0wr0HKzbinrEgKystdWECTVhE18wZpBVMdtSOrCBkLQgO0PeG5v492VTS07nqqW4ftkGVNXBpsa2adRLfMG11C7QcE9HZAJnVKRfra8UYfUy1ZIBpJu8rr3wRxUh4xy6ioqNmE6Twe1d142ZA4ciabclxsGzQ9v9XlVwg9yWSOfZADtbcBTlPoJ3D29epw9v83evAredMLwqEvTZPvSVI/gozkmitwk83dt+vMWDmEoOd4MRsz+0OkgTKbQ4btzXkWX27p3c8M3m53HBbLVjoIKvVLGXopp/5DWWZAzLXk4bDMdqIh/Pp/nIpMLlzD1NYs3bXwiitnOXyHKbeTJ1O4OL60uGy1c1fz6dnExO9o10fZlWvANPTwnf6bwazizlV++ACj3fMGhLWQRpnIvUKPu8E+M3bsy0fr6t/z+H//gcZhsRPtHUG8XW5Akkc6yzgW6LbCD2Q82jkS/r9UxF/B7MZiOf84vDtqp0FHlswrkycWzn4aCObrLxX8HY5Ac13eMqr89SmVbiyaFLFbQwMvtPPlWjqvgVEildwkVZoqdB1t5rvrM5nz584136A40nS2E=
99
sidebar_class_name: "get api-method"
10-
info_path: nixhub/nixhub-api
10+
info_path: devbox/nixhub/nixhub-api
1111
custom_edit_url: null
1212
---
1313

@@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
2020
import ResponseSamples from "@theme/ResponseSamples";
2121
import SchemaItem from "@theme/SchemaItem";
2222
import SchemaTabs from "@theme/SchemaTabs";
23-
import Markdown from "@theme/Markdown";
2423
import Heading from "@theme/Heading";
2524
import OperationTabs from "@theme/OperationTabs";
2625
import TabItem from "@theme/TabItem";
@@ -35,13 +34,15 @@ import TabItem from "@theme/TabItem";
3534
<MethodEndpoint
3635
method={"get"}
3736
path={"/search"}
37+
context={"endpoint"}
3838
>
3939

4040
</MethodEndpoint>
4141

4242

4343

44-
Search Packages. This endpoint allows you to search for packages in the Nixpkgs repository using a search query. The response includes a list of package names along with their description. To get available versions and installables for a package, you can use this name with the `/v2/pkg` endpoint.
44+
Search Packages. This endpoint allows you to search for packages in the Nixpkgs repository using a search query. The response includes a list of package names along with their description. To get available versions and installables for a package, you can use this name with the `/v2/pkg` endpoint.
45+
4546

4647
<Heading
4748
id={"request"}
@@ -69,7 +70,7 @@ Search Packages. This endpoint allows you to search for packages in the Nixpkgs
6970
<ul>
7071
<ParamsItem
7172
className={"paramsItem"}
72-
param={{"name":"q","in":"query","required":true,"description":"Search query.","schema":{"type":"string"}}}
73+
param={{"name":"q","in":"query","required":true,"description":"Search query.","schema":{"type":"string"},"enumDescriptions":[]}}
7374
>
7475

7576
</ParamsItem>

docs/app/docs/nixhub/sidebar.ts renamed to docs/app/nixhub/sidebar.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,26 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
22

33
const nixhubSidebar: SidebarsConfig = {
44
sidebar: [
5+
{
6+
type: "doc",
7+
id: "index",
8+
},
59
{
610
type: "doc",
711
label: "Get a Package",
8-
id: "nixhub/get-a-package",
12+
id: "get-a-package",
913
},
1014
{
1115
type: "doc",
1216
label: "Search Packages",
13-
id: "nixhub/search-packages",
17+
id: "search-packages",
1418
},
1519
{
1620
type: "doc",
1721
label: "Resolve a Package",
18-
id: "nixhub/resolve-a-package-version",
22+
id: "resolve-a-package-version",
1923
},
2024
],
2125
};
2226

23-
export default nixhubSidebar.sidebar;
27+
export default nixhubSidebar.sidebar;

docs/app/nixhub_sidebars.js

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Creating a sidebar enables you to:
3+
- create an ordered group of docs
4+
- render a sidebar for each doc of that group
5+
- provide next/previous navigation
6+
7+
The sidebars can be generated from the filesystem, or explicitly defined here.
8+
9+
Create as many sidebars as you want.
10+
*/
11+
12+
// @ts-check
13+
14+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
15+
const sidebars = {
16+
// By default, Docusaurus generates a sidebar from the docs folder structure
17+
// tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
18+
19+
// But you can create a sidebar manually
20+
nixhub_sidebar: require("./nixhub/sidebar"),
21+
};
22+
23+
export default sidebars;

0 commit comments

Comments
 (0)