diff --git a/docs/README.md b/docs/README.md index e51f133c205..2cc294fe1de 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,21 +8,22 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ```bash cd docs/app # from the devbox root directory devbox shell # optional, develop inside a devbox -yarn install # run in devbox shell +pnpm install # run in devbox shell ``` ### Local Development ```bash -yarn start +devbox run start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +NOTE: this will open localhost:3000/docs that will show a 404 Not Found. Go to localhost:3000/docs/devbox instead to find the real docs. ### Build ```bash -yarn build +devbox run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. diff --git a/docs/app/nixhub/get-a-package.api.mdx b/docs/app/nixhub/get-a-package.api.mdx index 0aead69ccc9..75a79230a82 100644 --- a/docs/app/nixhub/get-a-package.api.mdx +++ b/docs/app/nixhub/get-a-package.api.mdx @@ -11,18 +11,13 @@ info_path: devbox/nixhub/nixhub-api custom_edit_url: null --- -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Heading from "@theme/Heading"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -
+ + + + - -

- Query Parameters -

-
-
    - - - -
-
-
-
- - -
- - - Ok - - -
- - - - -
- - - Schema - -
- -
    - - - - - - - - - -
    - - - - releases - - object[] - - -
    -
    - - - A list of Releases for the package. - - -
  • -
    - Array [ -
    -
  • - - - - -
    - - - - platforms - - object[] - - -
    -
    - - - A list of platforms this release is available on. - - -
  • -
    - Array [ -
    -
  • - - - - - - - - - - - - -
    - - - - outputs - - object[] - - -
    -
    - - - A list of Outputs (e.g., `out`, `lib`, `dev`) that are available for the package on this platform. - - -
  • -
    - Array [ -
    -
  • - - - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
  • -
    - ] -
    -
  • -
    -
    -
    - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
-
-
- - - - -
-
-
-
-
-
- - - Bad Request: empty package name (set a ?name=<pkg> query parameter) - - -
- -
-
-
- - - Not Found - - -
- -
-
-
-
-
+ + + + + + + + \ No newline at end of file diff --git a/docs/app/nixhub/resolve-a-package-version.api.mdx b/docs/app/nixhub/resolve-a-package-version.api.mdx index 5a7ab12cf2f..9eb852a7d4f 100644 --- a/docs/app/nixhub/resolve-a-package-version.api.mdx +++ b/docs/app/nixhub/resolve-a-package-version.api.mdx @@ -11,18 +11,13 @@ info_path: devbox/nixhub/nixhub-api custom_edit_url: null --- -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Heading from "@theme/Heading"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -
+ + + + - -

- Query Parameters -

-
-
    - - - - - -
-
-
-
- - -
- - - OK - - -
- - - - -
- - - Schema - -
- -
    - - - - - - - -
    - - - - systems - - object - - -
    -
    - - - A list of systems that the package can be installed on, along with the details of the Package on that system. - - -
    -
    - - - - aarch64-darwin - - object - - -
    - -
    - - - - flake_installable - - object - - -
    -
    - - - The information needed to install this package as a flake reference. - - -
    -
    - - - - ref - - object - - -
    -
    - - - The full Nix reference to the flake that contains this package. - - -
    - - - - - - - - -
    -
    -
    - - -
    -
    -
    - - -
    - - - - outputs - - object[] - - -
    -
    - - - A list of Outputs (e.g., `out`, `lib`, `dev`) that are available for the package on this platform. - - -
  • -
    - Array [ -
    -
  • - - - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
    -
    -
    -
    - - - - aarch64-linux - - object - - -
    - -
    - - - - flake_installable - - object - - -
    -
    - - - The information needed to install this package as a flake reference. - - -
    -
    - - - - ref - - object - - -
    -
    - - - The full Nix reference to the flake that contains this package. - - -
    - - - - - - - - -
    -
    -
    - - -
    -
    -
    - - -
    - - - - outputs - - object[] - - -
    -
    - - - A list of Outputs (e.g., `out`, `lib`, `dev`) that are available for the package on this platform. - - -
  • -
    - Array [ -
    -
  • - - - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
    -
    -
    -
    - - - - x86_64-darwin - - object - - -
    - -
    - - - - flake_installable - - object - - -
    -
    - - - The information needed to install this package as a flake reference. - - -
    -
    - - - - ref - - object - - -
    -
    - - - The full Nix reference to the flake that contains this package. - - -
    - - - - - - - - -
    -
    -
    - - -
    -
    -
    - - -
    - - - - outputs - - object[] - - -
    -
    - - - A list of Outputs (e.g., `out`, `lib`, `dev`) that are available for the package on this platform. - - -
  • -
    - Array [ -
    -
  • - - - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
    -
    -
    -
    - - - - x86_64-linux - - object - - -
    - -
    - - - - flake_installable - - object - - -
    -
    - - - The information needed to install this package as a flake reference. - - -
    -
    - - - - ref - - object - - -
    -
    - - - The full Nix reference to the flake that contains this package. - - -
    - - - - - - - - -
    -
    -
    - - -
    -
    -
    - - -
    - - - - outputs - - object[] - - -
    -
    - - - A list of Outputs (e.g., `out`, `lib`, `dev`) that are available for the package on this platform. - - -
  • -
    - Array [ -
    -
  • - - - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
    -
    -
    -
    -
    -
    -
-
-
- - - - -
-
-
-
-
-
- - - 400 Bad Request: empty name (set a ?name=<value> query parameter) - - -
- -
-
-
- - - Not Found - - -
- -
-
-
-
-
+ + + + query parameter)"},"404":{"description":"Not Found"}}} +> + + + + \ No newline at end of file diff --git a/docs/app/nixhub/search-packages.api.mdx b/docs/app/nixhub/search-packages.api.mdx index 73a21a52010..a3cdbc449d3 100644 --- a/docs/app/nixhub/search-packages.api.mdx +++ b/docs/app/nixhub/search-packages.api.mdx @@ -11,18 +11,13 @@ info_path: devbox/nixhub/nixhub-api custom_edit_url: null --- -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Heading from "@theme/Heading"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; -
+ + + + - -

- Query Parameters -

-
-
    - - - -
-
-
-
- - -
- - - OK - - -
- - - - -
- - - Schema - -
- -
    - - - - - -
    - - - - results - - object[] - - -
    -
    - - - A list of SearchResults that match the query. This array will be empty if no results were found. - - -
  • -
    - Array [ -
    -
  • - - - - - -
  • -
    - ] -
    -
  • -
    -
    -
    -
-
-
- - - - -
-
-
-
-
-
- - - Bad Request: empty search query (set a ?q=<query> query parameter) - - -
- -
-
-
- - - Not Found - - -
- -
-
-
-
-
+ + + + query parameter)"},"404":{"description":"Not Found"}}} +> + + + + \ No newline at end of file