Skip to content

Commit

Permalink
Reorganize docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lagoja committed Oct 4, 2024
1 parent 3ed10ab commit e108901
Show file tree
Hide file tree
Showing 15 changed files with 13,890 additions and 32,498 deletions.
38 changes: 26 additions & 12 deletions docs/app/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const config = {
title: "Jetify Docs",
tagline: "Instant, easy, and predictable shells and containers",
url: "https://www.jetify.com",
baseUrl: "/",
baseUrl: "/docs",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
Expand Down Expand Up @@ -38,11 +38,10 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
routeBasePath: "/devbox/docs",
routeBasePath: "/devbox",
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
docItemComponent: "@theme/ApiItem",
editUrl: "https://github.com/jetify-com/devbox/tree/main/docs/app/",
},
blog: false,
Expand All @@ -64,14 +63,23 @@ const config = {
{
id: "cloud",
path: "cloud",
routeBasePath: "/cloud/docs",
routeBasePath: "cloud",
sidebarPath: require.resolve("./cloud_sidebars.js"),
},
],[
"@docusaurus/plugin-content-docs",
{
id: "nixhub",
path: "nixhub",
routeBasePath: "nixhub",
sidebarPath: require.resolve("./nixhub_sidebars.js"),
docItemComponent: "@theme/ApiItem"
}
],
[
"docusaurus-plugin-openapi-docs",
{
id: "api",
id: "nixhub",
docsPluginId: "classic",
config: {
nixhub: {
Expand All @@ -88,20 +96,26 @@ const config = {
({
navbar: {
logo: {
alt: "Devbox",
src: "img/devbox_logo_light.svg",
srcDark: "img/devbox_logo_dark.svg",
href: "/devbox/docs",
alt: "Jetify Docs",
src: "img/jetify-docs-logo-light.svg",
srcDark: "img/jetify-docs-logo-dark.svg",
href: "devbox",
},
items: [
{
to: "cloud/docs",
to: "devbox",
label: "Devbox",
className: "header-text-link",
position: "left"
},
{
to: "cloud",
label: "Jetify Cloud",
className: "header-text-link",
position: "left",
},
{
to: "/devbox/docs/nixhub",
to: "nixhub",
label: "NixHub API",
className: "header-text-link",
position: "left",
Expand Down Expand Up @@ -148,7 +162,7 @@ const config = {
},
{
label: "Docs",
to: "https://www.jetify.com/devbox/docs/",
to: "https://www.jetify.com/docs/devbox",
},
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ hide_title: true
hide_table_of_contents: true
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==
sidebar_class_name: "get api-method"
info_path: nixhub/nixhub-api
info_path: devbox/nixhub/nixhub-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand All @@ -35,6 +34,7 @@ import TabItem from "@theme/TabItem";
<MethodEndpoint
method={"get"}
path={"/pkg"}
context={"endpoint"}
>

</MethodEndpoint>
Expand Down Expand Up @@ -71,7 +71,7 @@ You should use this endpoint if you know the name of the package you want to loo
<ul>
<ParamsItem
className={"paramsItem"}
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"}}}
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":[]}}
>

</ParamsItem>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: resolve-a-package-version
title: "Resolve a Package Version"
description: "Resolve a Package Version"
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."
sidebar_label: "Resolve a Package Version"
hide_title: true
hide_table_of_contents: true
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
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==
sidebar_class_name: "get api-method"
info_path: nixhub/nixhub-api
info_path: devbox/nixhub/nixhub-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand All @@ -35,13 +34,15 @@ import TabItem from "@theme/TabItem";
<MethodEndpoint
method={"get"}
path={"/resolve"}
context={"endpoint"}
>

</MethodEndpoint>



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.
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.


<Heading
id={"request"}
Expand Down Expand Up @@ -69,12 +70,12 @@ Resolve a Package Version. This endpoint resolves a package name + version strin
<ul>
<ParamsItem
className={"paramsItem"}
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"}}}
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":[]}}
>

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

</ParamsItem>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: search-packages
title: "Search Packages"
description: "Search Packages"
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."
sidebar_label: "Search Packages"
hide_title: true
hide_table_of_contents: true
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
api: eJztVU1v2zAM/SuETx1QJEXRU7EPdMA2FAO6ottO3bApNhOrlSVVotMGQf77SFlOHScDuvtObUzxvUfyUVoXFcYyaE/a2eK8+IoqlDVcq/JeLTBO4FutI6CtvNOWQBnjHiOsXAvkIHaH5y6AzwmgLVCNcKWf/P0iQkDvoiYXVtBGbReg+qyHFsNqAkyAfCp6ZyNydmlaVsTHjI4Ebt4jg1WNfDeOQR411UKjAwzks1gHC2SVS6WNmhmEJYbIEc6zFYNH4gIkEJNo1YMfp4pKZVkkMjCXLHRbHvg9XZ5OuaDf21ZM4IctjoteeSzO18XpyYn82e3ol898rHSW0JJElfdGl0qi07soR9ZFLGtslPxHK4+c5GZ3WBIn7mJdWOgi0lemZkjpKXUtbA1F6di4xWmEWmZBbbBYwWz1XFR39Lku5vTBeQyku6ISyEBapMCce9JkjENaEHFikr8zbY4LcjyRX1n7gITDuMBwkCXlgG2bGQYpt69cJkojFcKxj65CUKv95m4t1y3BTcalWhE0isrOCsOmJiB2iTEwQ8DG0wr0HKzbinrEgKystdWECTVhE18wZpBVMdtSOrCBkLQgO0PeG5v492VTS07nqqW4ftkGVNXBpsa2adRLfMG11C7QcE9HZAJnVKRfra8UYfUy1ZIBpJu8rr3wRxUh4xy6ioqNmE6Twe1d142ZA4ciabclxsGzQ9v9XlVwg9yWSOfZADtbcBTlPoJ3D29epw9v83evAredMLwqEvTZPvSVI/gozkmitwk83dt+vMWDmEoOd4MRsz+0OkgTKbQ4btzXkWX27p3c8M3m53HBbLVjoIKvVLGXopp/5DWWZAzLXk4bDMdqIh/Pp/nIpMLlzD1NYs3bXwiitnOXyHKbeTJ1O4OL60uGy1c1fz6dnExO9o10fZlWvANPTwnf6bwazizlV++ACj3fMGhLWQRpnIvUKPu8E+M3bsy0fr6t/z+H//gcZhsRPtHUG8XW5Akkc6yzgW6LbCD2Q82jkS/r9UxF/B7MZiOf84vDtqp0FHlswrkycWzn4aCObrLxX8HY5Ac13eMqr89SmVbiyaFLFbQwMvtPPlWjqvgVEildwkVZoqdB1t5rvrM5nz584136A40nS2E=
sidebar_class_name: "get api-method"
info_path: nixhub/nixhub-api
info_path: devbox/nixhub/nixhub-api
custom_edit_url: null
---

Expand All @@ -20,7 +20,6 @@ import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
Expand All @@ -35,13 +34,15 @@ import TabItem from "@theme/TabItem";
<MethodEndpoint
method={"get"}
path={"/search"}
context={"endpoint"}
>

</MethodEndpoint>



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.
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.


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

</ParamsItem>
Expand Down
12 changes: 8 additions & 4 deletions docs/app/docs/nixhub/sidebar.ts → docs/app/nixhub/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,26 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";

const nixhubSidebar: SidebarsConfig = {
sidebar: [
{
type: "doc",
id: "index",
},
{
type: "doc",
label: "Get a Package",
id: "nixhub/get-a-package",
id: "get-a-package",
},
{
type: "doc",
label: "Search Packages",
id: "nixhub/search-packages",
id: "search-packages",
},
{
type: "doc",
label: "Resolve a Package",
id: "nixhub/resolve-a-package-version",
id: "resolve-a-package-version",
},
],
};

export default nixhubSidebar.sidebar;
export default nixhubSidebar.sidebar;
23 changes: 23 additions & 0 deletions docs/app/nixhub_sidebars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],

// But you can create a sidebar manually
nixhub_sidebar: require("./nixhub/sidebar"),
};

export default sidebars;
Loading

0 comments on commit e108901

Please sign in to comment.