From 810b62cb2214c2117fdc8e0f638be2f829e7c814 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20De=20Boey?= Date: Fri, 25 Aug 2023 16:29:40 +0200 Subject: [PATCH] docs: remove API docs (#7243) --- docs/api/conventions.md | 231 --------------------------- docs/api/index.md | 4 - docs/api/remix.md | 340 ---------------------------------------- 3 files changed, 575 deletions(-) delete mode 100644 docs/api/conventions.md delete mode 100644 docs/api/index.md delete mode 100644 docs/api/remix.md diff --git a/docs/api/conventions.md b/docs/api/conventions.md deleted file mode 100644 index 054179bf14c..00000000000 --- a/docs/api/conventions.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -title: Conventions ---- - -# Conventions - -The docs in this page have moved to their own pages - -## remix.config.js - -[Moved →][moved] - -### appDirectory - -[Moved →][moved-2] - -### assetsBuildDirectory - -[Moved →][moved-3] - -### cacheDirectory - -[Moved →][moved-4] - -### ignoredRouteFiles - -[Moved →][moved-7] - -### publicPath - -[Moved →][moved-8] - -### routes - -[Moved →][moved-9] - -### server - -[Moved →][moved-10] - -### serverBuildDirectory - -[Moved →][moved-11] - -### serverBuildPath - -[Moved →][moved-12] - -### serverDependenciesToBundle - -[Moved →][moved-14] - -### watchPaths - -[Moved →][moved-15] - -## File Name Conventions - -### Special Files - -### Route File Conventions - -[Moved →][moved-16] - -#### Root Layout Route - -[Moved →][moved-17] - -#### Basic Routes - -[Moved →][moved-18] - -#### Dynamic Route Parameters - -[Moved →][moved-19] - -#### Layout Routes - -[Moved →][moved-20] - -#### Pathless Layout Routes - -[Moved →][moved-21] - -#### Dot Delimiters - -[Moved →][moved-22] - -#### Splat Routes - -[Moved →][moved-23] - -### Escaping special characters - -[Moved →][moved-24] - -## Entry Files - -### entry.client.tsx - -[Moved →][moved-25] - -### entry.server.tsx - -[Moved →][moved-26] - -## Route Module API - -### `default` export - -[Moved →][moved-27] - -### `loader` - -[Moved →][moved-28] - -#### loader `params` - -[Moved →][moved-29] - -#### loader `request` - -[Moved →][moved-30] - -#### loader `context` - -[Moved →][moved-31] - -#### Returning Response Instances - -[Moved →][moved-32] - -#### Throwing Responses in Loaders - -[Moved →][moved-33] - -### `action` - -[Moved →][moved-34] - -### `headers` - -[Moved →][moved-35] - -### `meta` - -[Moved →][moved-36] - -#### `MetaDescriptor` - -[Moved →][moved-37] - -#### Page context in `meta` function - -[Moved →][moved-38] - -### `links` - -[Moved →][moved-39] - -#### `HtmlLinkDescriptor` - -[Moved →][moved-40] - -#### `PageLinkDescriptor` - -[Moved →][moved-41] - -### ErrorBoundary - -[Moved →][moved-43] - -### handle - -[Moved →][moved-44] - -#### Never reloading the root - -\[Moved →]\[moved-46] - -#### Ignoring search params - -\[Moved →]\[moved-47] - -## Asset URL Imports - -[Moved →][moved-48] - -[moved]: ../file-conventions/remix-config -[moved-2]: ../file-conventions/remix-config#appdirectory -[moved-3]: ../file-conventions/remix-config#assetsbuilddirectory -[moved-4]: ../file-conventions/remix-config#cachedirectory -[moved-5]: ../file-conventions/remix-config#devserverbroadcastdelay -[moved-6]: ../file-conventions/remix-config#devserverport -[moved-7]: ../file-conventions/remix-config#ignoredroutefiles -[moved-8]: ../file-conventions/remix-config#publicpath -[moved-9]: ../file-conventions/remix-config#routes -[moved-10]: ../file-conventions/remix-config#server -[moved-11]: ../file-conventions/remix-config#serverbuilddirectory -[moved-12]: ../file-conventions/remix-config#serverbuildpath -[moved-14]: ../file-conventions/remix-config#serverdependenciestobundle -[moved-15]: ../file-conventions/remix-config#watchpaths -[moved-16]: ../file-conventions/routes-files -[moved-17]: ../file-conventions/root -[moved-18]: ../file-conventions/routes-files#basic-routes -[moved-19]: ../file-conventions/routes-files#dynamic-route-parameters -[moved-20]: ../file-conventions/routes-files#layout-routes -[moved-21]: ../file-conventions/routes-files#pathless-layout-routes -[moved-22]: ../file-conventions/routes-files#dot-delimiters -[moved-23]: ../file-conventions/routes-files#splat-routes -[moved-24]: ../file-conventions/routes-files#escaping-special-characters -[moved-25]: ../file-conventions/entry.client -[moved-26]: ../file-conventions/entry.server -[moved-27]: ../route/component -[moved-28]: ../route/loader -[moved-29]: ../route/loader#params -[moved-30]: ../route/loader#request -[moved-31]: ../route/loader#context -[moved-32]: ../route/loader#returning-response-instances -[moved-33]: ../route/loader#throwing-responses-in-loaders -[moved-34]: ../route/action -[moved-35]: ../route/headers -[moved-36]: ../route/meta -[moved-37]: ../route/meta#htmlmetadescriptor -[moved-38]: ../route/meta#page-context-in-meta-function -[moved-39]: ../route/links -[moved-40]: ../route/links#htmllinkdescriptor -[moved-41]: ../route/links#pagelinkdescriptor -[moved-43]: ../route/error-boundary -[moved-44]: ../route/handle -[moved-48]: ../other-api/asset-imports diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 2f2a485d126..00000000000 --- a/docs/api/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: API -hidden: true ---- diff --git a/docs/api/remix.md b/docs/api/remix.md deleted file mode 100644 index aad42b3799e..00000000000 --- a/docs/api/remix.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -title: Remix Packages ---- - -# Remix Packages - -The docs in this page have moved to their own pages - -## Components and Hooks - -### ``, ``, ``, ``, `` - -- [Links Moved →][links-moved] -- [LiveReload Moved →][live-reload-moved] -- [Meta Moved →][meta-moved] -- [Scripts Moved →][scripts-moved] -- [ScrollRestoration Moved →][scroll-restoration-moved] - -### `` - -[Moved →][moved] - -### `` - -[Moved →][moved-68] - -### `` - -[Moved →][moved-2] - -### `
` - -[Moved →][moved-3] - -#### `` - -[Moved →][moved-4] - -#### `` - -[Moved →][moved-5] - -#### `` - -[Moved →][moved-6] - -#### `` - -[Moved →][moved-7] - -#### `` - -[Moved →][moved-8] - -### `` - -[Moved →][moved-9] - -### `useLoaderData` - -[Moved →][moved-10] - -### `useActionData` - -[Moved →][moved-11] - -#### Notes about resubmissions - -[Moved →][moved-12] - -### `useFormAction` - -[Moved →][moved-13] - -### `useSubmit` - -[Moved →][moved-14] - -### `useFetcher` - -[Moved →][moved-20] - -#### `fetcher.state` - -[Moved →][moved-21] - -#### `fetcher.type` - -[Moved →][moved-22] - -#### `fetcher.submission` - -[Moved →][moved-23] - -#### `fetcher.data` - -[Moved →][moved-24] - -#### `fetcher.Form` - -[Moved →][moved-25] - -#### `fetcher.submit()` - -[Moved →][moved-26] - -#### `fetcher.load()` - -[Moved →][moved-27] - -#### Examples - -[Moved →][moved-28] - -### `useFetchers` - -[Moved →][moved-29] - -### `useMatches` - -[Moved →][moved-30] - -### `useBeforeUnload` - -[Moved →][moved-31] - -## HTTP Helpers - -### `json` - -[Moved →][moved-32] - -### `redirect` - -[Moved →][moved-33] - -### `unstable_parseMultipartFormData` - -[Moved →][moved-34] - -### `uploadHandler` - -[Moved →][moved-35] - -#### `unstable_createFileUploadHandler` - -[Moved →][moved-36] - -#### `unstable_createMemoryUploadHandler` - -[Moved →][moved-37] - -### Upload Handler Composition - -[Moved →][moved-38] - -## Cookies - -[Moved →][moved-39] - -### Using cookies - -[Moved →][moved-40] - -### Cookie attributes - -[Moved →][moved-41] - -### Signing cookies - -[Moved →][moved-42] - -### `createCookie` - -[Moved →][moved-43] - -### `isCookie` - -[Moved →][moved-44] - -### Cookie API - -[Moved →][moved-45] - -#### `cookie.name` - -[Moved →][moved-46] - -#### `cookie.parse()` - -[Moved →][moved-47] - -#### `cookie.serialize()` - -[Moved →][moved-48] - -#### `cookie.isSigned` - -[Moved →][moved-49] - -#### `cookie.expires` - -[Moved →][moved-50] - -## Sessions - -[Moved →][moved-51] - -### Using Sessions - -[Moved →][moved-52] - -### Session Gotchas - -[Moved →][moved-53] - -### `createSession` - -[Moved →][moved-54] - -### `isSession` - -[Moved →][moved-55] - -### `createSessionStorage` - -[Moved →][moved-56] - -### `createCookieSessionStorage` - -[Moved →][moved-57] - -### `createMemorySessionStorage` - -[Moved →][moved-58] - -### `createFileSessionStorage` (node) - -[Moved →][moved-59] - -### `createWorkersKVSessionStorage` (Cloudflare Workers) - -[Moved →][moved-60] - -### `createArcTableSessionStorage` (architect, Amazon DynamoDB) - -[Moved →][moved-61] - -### Session API - -[Moved →][moved-62] - -#### `session.has(key)` - -[Moved →][moved-63] - -#### `session.set(key, value)` - -[Moved →][moved-64] - -#### `session.flash(key, value)` - -[Moved →][moved-65] - -#### `session.get()` - -[Moved →][moved-66] - -#### `session.unset()` - -[Moved →][moved-67] - -[links-moved]: ../components/links -[live-reload-moved]: ../components/live-reload -[meta-moved]: ../components/meta -[scripts-moved]: ../components/scripts -[scroll-restoration-moved]: ../components/ScrollRestoration -[moved]: ../components/link -[moved-2]: ../components/nav-link -[moved-3]: ../components/form -[moved-4]: ../components/form#action -[moved-5]: ../components/form#method -[moved-6]: ../components/form#enctype -[moved-7]: ../components/form#replace -[moved-8]: ../components/form#reloaddocument -[moved-9]: ../components/scroll-restoration -[moved-10]: ../hooks/use-loader-data -[moved-11]: ../hooks/use-action-data -[moved-12]: ../hooks/use-action-data#notes-about-resubmissions -[moved-13]: ../hooks/use-form-action -[moved-14]: ../hooks/use-submit -[moved-20]: ../hooks/use-fetcher -[moved-21]: ../hooks/use-fetcher#fetcherstate -[moved-22]: ../hooks/use-fetcher#fetchertype -[moved-23]: ../hooks/use-fetcher#fetchersubmission -[moved-24]: ../hooks/use-fetcher#fetcherdata -[moved-25]: ../hooks/use-fetcher#fetcherform -[moved-26]: ../hooks/use-fetcher#fetchersubmit -[moved-27]: ../hooks/use-fetcher#fetcherload -[moved-28]: ../hooks/use-fetcher#examples -[moved-29]: ../hooks/use-fetchers -[moved-30]: ../hooks/use-matches -[moved-31]: ../hooks/use-before-unload -[moved-32]: ../utils/json -[moved-33]: ../utils/redirect -[moved-34]: ../utils/parse-multipart-form-data -[moved-35]: ../utils/parse-multipart-form-data#uploadhandler -[moved-36]: ../utils/unstable-create-file-upload-handler -[moved-37]: ../utils/unstable-create-memory-upload-handler -[moved-38]: ../guides/file-uploads#upload-handler-composition -[moved-39]: ../utils/cookies -[moved-40]: ../utils/cookies#using-cookies -[moved-41]: ../utils/cookies#cookie-attributes -[moved-42]: ../utils/cookies#signing-cookies -[moved-43]: ../utils/cookies#createcookie -[moved-44]: ../utils/cookies#iscookie -[moved-45]: ../utils/cookies#cookie-api -[moved-46]: ../utils/cookies#cookiename -[moved-47]: ../utils/cookies#cookieparse -[moved-48]: ../utils/cookies#cookieserialize -[moved-49]: ../utils/cookies#cookieissigned -[moved-50]: ../utils/cookies#cookieexpires -[moved-51]: ../utils/sessions -[moved-52]: ../utils/sessions#using-sessions -[moved-53]: ../utils/sessions#session-gotchas -[moved-54]: ../utils/sessions#createsession -[moved-55]: ../utils/sessions#issession -[moved-56]: ../utils/sessions#createsessionstorage -[moved-57]: ../utils/sessions#createcookiesessionstorage -[moved-58]: ../utils/sessions#creatememorysessionstorage -[moved-59]: ../utils/sessions#createfilesessionstorage-node -[moved-60]: ../utils/sessions#createworkerskvsessionstorage-cloudflare-workers -[moved-61]: ../utils/sessions#createarctablesessionstorage-architect-amazon-dynamodb -[moved-62]: ../utils/sessions#session-api -[moved-63]: ../utils/sessions#sessionhaskey -[moved-64]: ../utils/sessions#sessionsetkey-value -[moved-65]: ../utils/sessions#sessionflashkey-value -[moved-66]: ../utils/sessions#sessionget -[moved-67]: ../utils/sessions#sessionunset -[moved-68]: ../components/prefetch-page-links