diff --git a/packages/app-vscode/package.json b/packages/app-vscode/package.json index 1fbaefad61..e6362a9862 100644 --- a/packages/app-vscode/package.json +++ b/packages/app-vscode/package.json @@ -1219,7 +1219,7 @@ } }, "cursorless.experimental.hatStability": { - "markdownDescription": "As you scroll, edit, and move your cursor, this setting determines how much Cursorless will move hats around to ensure that the best hats are near the cursor. See https://www.cursorless.org/docs/user/hatAssignment/", + "markdownDescription": "As you scroll, edit, and move your cursor, this setting determines how much Cursorless will move hats around to ensure that the best hats are near the cursor. See https://www.cursorless.org/docs/user/hat-assignment/", "type": "string", "default": "balanced", "enum": [ diff --git a/packages/app-web-docs/docusaurus.config.mts b/packages/app-web-docs/docusaurus.config.mts index 1c301883df..33131f9ece 100644 --- a/packages/app-web-docs/docusaurus.config.mts +++ b/packages/app-web-docs/docusaurus.config.mts @@ -6,6 +6,7 @@ import type { Root } from "mdast"; import { themes } from "prism-react-renderer"; import type { Transformer } from "unified"; import { visit } from "unist-util-visit"; +import { sidebarItemsGenerator } from "./sidebarItemsGenerator.ts"; // oxlint-disable-next-line unicorn/prefer-import-meta-properties const __dirname = path.dirname(fileURLToPath(import.meta.url)); @@ -152,6 +153,7 @@ const config: Config = { editUrl: "https://github.com/cursorless-dev/cursorless/edit/main/packages/app-web-docs/", sidebarPath: require.resolve("./sidebar.js"), + sidebarItemsGenerator, beforeDefaultRemarkPlugins: [ remarkPluginFixLinksToRepositoryArtifacts, ], diff --git a/packages/app-web-docs/sidebarItemsGenerator.ts b/packages/app-web-docs/sidebarItemsGenerator.ts new file mode 100644 index 0000000000..3878d5c78b --- /dev/null +++ b/packages/app-web-docs/sidebarItemsGenerator.ts @@ -0,0 +1,118 @@ +import type * as ClassicPreset from "@docusaurus/preset-classic"; + +type DocsOptions = Exclude; +type SidebarItemsGenerator = NonNullable; + +interface Group { + label: string; + items: string[]; +} + +const items: (Group | string)[] = [ + "Cursorless", + { + label: "Getting started", + items: ["Installation", "How-to guides"], + }, + { + label: "Reference", + items: ["Actions", "Modifiers", "Scopes", "Destinations"], + }, + "Supported languages", + { + label: "Customization", + items: ["Customization", "Hat assignment", "Visual Accessibility"], + }, + { + label: "Tools", + items: ["Cursorless sidebar", "Scope visualizer", "Local command history"], + }, + { + label: "Advanced", + items: ["Unicode support", "Experimental features"], + }, + { + label: "Project", + items: ["Updating", "Glossary", "Release notes"], + }, +]; + +export const sidebarItemsGenerator: SidebarItemsGenerator = async ({ + defaultSidebarItemsGenerator, + ...args +}) => { + const generatedItems = await defaultSidebarItemsGenerator(args); + + type NormalizedSidebarItem = (typeof generatedItems)[number]; + + if (args.item.dirName !== "user") { + return generatedItems; + } + + const docsById = new Map(args.docs.map((doc) => [doc.id, doc])); + const remainingItems = generatedItems.slice(); + + function getLabel(item: (typeof generatedItems)[number]) { + if (item.type === "doc" || item.type === "ref") { + const doc = docsById.get(item.id); + return doc?.frontMatter.sidebar_label ?? doc?.title; + } + if ("label" in item) { + return item.label; + } + throw new Error(`Unexpected sidebar item type: ${item.type}`); + } + + function takeItem(label: string): NormalizedSidebarItem { + const index = remainingItems.findIndex( + (item) => getLabel(item)?.toLowerCase() === label.toLowerCase(), + ); + const item = remainingItems[index]; + if (item == null) { + throw new Error(`Missing generated sidebar item '${label}'`); + } + remainingItems.splice(index, 1); + return item; + } + + function createGroup(group: Group): NormalizedSidebarItem { + const items = group.items.map(takeItem); + const linkIndex = items.findIndex( + (item) => item.type === "doc" && getLabel(item) === group.label, + ); + const [link] = linkIndex === -1 ? [] : items.splice(linkIndex, 1); + + return { + type: "category", + label: group.label, + collapsible: false, + collapsed: false, + ...(link?.type === "doc" ? { link: { type: "doc", id: link.id } } : {}), + items, + }; + } + + const groupedItems = items.map((item): NormalizedSidebarItem => { + if (typeof item === "string") { + return takeItem(item); + } + return createGroup(item); + }); + + if (remainingItems.length > 0) { + const remainingJson = remainingItems + .map((item) => { + if (item.type === "category") { + const { items, ...rest } = item; + return JSON.stringify(rest); + } + return JSON.stringify(item); + }) + .join(", "); + throw new Error( + `Unassigned generated user sidebar items: ${remainingJson}`, + ); + } + + return groupedItems; +}; diff --git a/packages/app-web-docs/src/docs/user/languages/components/Language.tsx b/packages/app-web-docs/src/docs/components/Language.tsx similarity index 55% rename from packages/app-web-docs/src/docs/user/languages/components/Language.tsx rename to packages/app-web-docs/src/docs/components/Language.tsx index 193074484f..d0abdd2648 100644 --- a/packages/app-web-docs/src/docs/user/languages/components/Language.tsx +++ b/packages/app-web-docs/src/docs/components/Language.tsx @@ -1,7 +1,7 @@ import React from "react"; -import { DynamicTOC } from "../../../components/DynamicTOC"; -import { ScopeVisualizer } from "../../../components/ScopeVisualizer"; -import { ScrollToHashId } from "../../../components/ScrollToHashId"; +import { DynamicTOC } from "./DynamicTOC"; +import { ScopeVisualizer } from "./ScopeVisualizer"; +import { ScrollToHashId } from "./ScrollToHashId"; interface Props { languageId: string; diff --git a/packages/app-web-docs/src/docs/contributing/adding-a-new-language.md b/packages/app-web-docs/src/docs/contributing/adding-a-new-language.md index ff4d37a51e..b5104f666e 100644 --- a/packages/app-web-docs/src/docs/contributing/adding-a-new-language.md +++ b/packages/app-web-docs/src/docs/contributing/adding-a-new-language.md @@ -43,7 +43,7 @@ Follow the instructions in [Adding a new scope](./adding-a-new-scope.md) to defi Create a `.mdx` file in [`languages`](../user/languages) with the `Language` react component. The file should be named after your language, eg `java.mdx` ```md -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Java diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json b/packages/app-web-docs/src/docs/contributing/private-scopes/_category_.json similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json rename to packages/app-web-docs/src/docs/contributing/private-scopes/_category_.json diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/customRegex.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/customRegex.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/disqualifyDelimiter.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/disqualifyDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/disqualifyDelimiter.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/disqualifyDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/fieldAccess.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/fieldAccess.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/interior.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/interior.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/pairDelimiter.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/pairDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/pairDelimiter.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/pairDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/string.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/string.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/surroundingPairInterior.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/surroundingPairInterior.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/surroundingPairInterior.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/surroundingPairInterior.mdx diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx b/packages/app-web-docs/src/docs/contributing/private-scopes/textFragment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx rename to packages/app-web-docs/src/docs/contributing/private-scopes/textFragment.mdx diff --git a/packages/app-web-docs/src/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index fd96d57744..78950f943c 100644 --- a/packages/app-web-docs/src/docs/user/README.md +++ b/packages/app-web-docs/src/docs/user/README.md @@ -1,9 +1,8 @@ --- slug: / -sidebar_position: 1 --- -# Cursorless documentation +# Cursorless Welcome to Cursorless! You may find it helpful to start with the [tutorial videos](https://www.youtube.com/watch?v=5mAzHGM2M0k&list=PLXv2sppxeoQZz49evjy4T0QJRIgc_JPqs). @@ -69,7 +68,7 @@ The following colors are supported. Note that to target the default (gray) hat y You can enable or disable colors in your VSCode settings, by searching for [`cursorless.hatEnablement.colors`](vscode://settings/cursorless.hatEnablement.colors) and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings. -You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for [`cursorless.colors`](vscode://settings/cursorless.colors) and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visualAccessibility.md) for more on visual accessibility. +You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for [`cursorless.colors`](vscode://settings/cursorless.colors) and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visual-accessibility.md) for more on visual accessibility. If you find these color names unintuitive / tough to remember, their spoken forms can be [customized](customization.md) like any other spoken form diff --git a/packages/app-web-docs/src/docs/user/actions/_category_.json b/packages/app-web-docs/src/docs/user/actions/_category_.json new file mode 100644 index 0000000000..9aac6c92fe --- /dev/null +++ b/packages/app-web-docs/src/docs/user/actions/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Actions" +} diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx b/packages/app-web-docs/src/docs/user/actions/addSelection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx rename to packages/app-web-docs/src/docs/user/actions/addSelection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx rename to packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx rename to packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx b/packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx rename to packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx b/packages/app-web-docs/src/docs/user/actions/breakLine.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx rename to packages/app-web-docs/src/docs/user/actions/breakLine.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx b/packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx rename to packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx b/packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx rename to packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx rename to packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx rename to packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx b/packages/app-web-docs/src/docs/user/actions/decrement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx rename to packages/app-web-docs/src/docs/user/actions/decrement.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx b/packages/app-web-docs/src/docs/user/actions/deselect.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx rename to packages/app-web-docs/src/docs/user/actions/deselect.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx b/packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx rename to packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx b/packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx rename to packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx b/packages/app-web-docs/src/docs/user/actions/extractVariable.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx rename to packages/app-web-docs/src/docs/user/actions/extractVariable.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx b/packages/app-web-docs/src/docs/user/actions/findInDocument.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx rename to packages/app-web-docs/src/docs/user/actions/findInDocument.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx b/packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx rename to packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx b/packages/app-web-docs/src/docs/user/actions/flashTargets.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx rename to packages/app-web-docs/src/docs/user/actions/flashTargets.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx b/packages/app-web-docs/src/docs/user/actions/foldRegion.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx rename to packages/app-web-docs/src/docs/user/actions/foldRegion.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx b/packages/app-web-docs/src/docs/user/actions/followLink.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx rename to packages/app-web-docs/src/docs/user/actions/followLink.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx b/packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx rename to packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx rename to packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx b/packages/app-web-docs/src/docs/user/actions/gitAccept.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx rename to packages/app-web-docs/src/docs/user/actions/gitAccept.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx b/packages/app-web-docs/src/docs/user/actions/gitRevert.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx rename to packages/app-web-docs/src/docs/user/actions/gitRevert.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx b/packages/app-web-docs/src/docs/user/actions/gitStage.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx rename to packages/app-web-docs/src/docs/user/actions/gitStage.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx b/packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx rename to packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx b/packages/app-web-docs/src/docs/user/actions/highlight.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx rename to packages/app-web-docs/src/docs/user/actions/highlight.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx b/packages/app-web-docs/src/docs/user/actions/increment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/increment.mdx rename to packages/app-web-docs/src/docs/user/actions/increment.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx b/packages/app-web-docs/src/docs/user/actions/indentLine.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx rename to packages/app-web-docs/src/docs/user/actions/indentLine.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx b/packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx rename to packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx b/packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx rename to packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx rename to packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx rename to packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx rename to packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx rename to packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx b/packages/app-web-docs/src/docs/user/actions/joinLines.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx rename to packages/app-web-docs/src/docs/user/actions/joinLines.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx b/packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx rename to packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx b/packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx rename to packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx b/packages/app-web-docs/src/docs/user/actions/outdentLine.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx rename to packages/app-web-docs/src/docs/user/actions/outdentLine.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx rename to packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx b/packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx rename to packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx b/packages/app-web-docs/src/docs/user/actions/remove.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/remove.mdx rename to packages/app-web-docs/src/docs/user/actions/remove.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx b/packages/app-web-docs/src/docs/user/actions/rename.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/rename.mdx rename to packages/app-web-docs/src/docs/user/actions/rename.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx b/packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx rename to packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx b/packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx rename to packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx b/packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx rename to packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx b/packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx rename to packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx rename to packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx rename to packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx rename to packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx rename to packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx b/packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx rename to packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx b/packages/app-web-docs/src/docs/user/actions/setSelection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx rename to packages/app-web-docs/src/docs/user/actions/setSelection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx rename to packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx rename to packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx b/packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx rename to packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx b/packages/app-web-docs/src/docs/user/actions/showHover.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx rename to packages/app-web-docs/src/docs/user/actions/showHover.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx b/packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx rename to packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx b/packages/app-web-docs/src/docs/user/actions/showReferences.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx rename to packages/app-web-docs/src/docs/user/actions/showReferences.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx b/packages/app-web-docs/src/docs/user/actions/sortTargets.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx rename to packages/app-web-docs/src/docs/user/actions/sortTargets.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx b/packages/app-web-docs/src/docs/user/actions/swapTargets.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx rename to packages/app-web-docs/src/docs/user/actions/swapTargets.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx b/packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx rename to packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx b/packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx rename to packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx b/packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx rename to packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx rename to packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx rename to packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/destinations.md b/packages/app-web-docs/src/docs/user/destinations.md similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/destinations.md rename to packages/app-web-docs/src/docs/user/destinations.md diff --git a/packages/app-web-docs/src/docs/user/experimental/_category_.json b/packages/app-web-docs/src/docs/user/experimental/_category_.json new file mode 100644 index 0000000000..1b181826ed --- /dev/null +++ b/packages/app-web-docs/src/docs/user/experimental/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Experimental features" +} diff --git a/packages/app-web-docs/src/docs/user/hatAssignment.md b/packages/app-web-docs/src/docs/user/hat-assignment.md similarity index 100% rename from packages/app-web-docs/src/docs/user/hatAssignment.md rename to packages/app-web-docs/src/docs/user/hat-assignment.md diff --git a/packages/app-web-docs/src/docs/user/how-to.md b/packages/app-web-docs/src/docs/user/how-to.md index de39de9e73..163ffeb83a 100644 --- a/packages/app-web-docs/src/docs/user/how-to.md +++ b/packages/app-web-docs/src/docs/user/how-to.md @@ -10,7 +10,7 @@ To replace a target with the contents of the clipboard, say `"paste to " :::info -`"to "` is an example of a Destination. See [Destinations](reference/destinations.md) for more information. +`"to "` is an example of a Destination. See [Destinations](destinations.md) for more information. ::: @@ -84,6 +84,6 @@ See the [Talon-side api docs](./customization.md#cursorless-public-api) for more :::info -Notice how we use `cursorless_create_destination` to create a destination for the result of the transformation. The `cursorless_insert` action expects a destination, so that it knows whether to replace, insert before, or insert after the target. See [Destinations](reference/destinations.md) for more information. +Notice how we use `cursorless_create_destination` to create a destination for the result of the transformation. The `cursorless_insert` action expects a destination, so that it knows whether to replace, insert before, or insert after the target. See [Destinations](destinations.md) for more information. ::: diff --git a/packages/app-web-docs/src/docs/user/languages/README.md b/packages/app-web-docs/src/docs/user/languages/README.md index 812eb756f0..e66f12d405 100644 --- a/packages/app-web-docs/src/docs/user/languages/README.md +++ b/packages/app-web-docs/src/docs/user/languages/README.md @@ -1,4 +1,4 @@ -# Languages +# Supported languages Cursorless supports a wide range of languages, though our level of support varies a bit from language to language. See the sidebar for information about how well we support various diff --git a/packages/app-web-docs/src/docs/user/languages/c.mdx b/packages/app-web-docs/src/docs/user/languages/c.mdx index 971c64b843..3954b55ccd 100644 --- a/packages/app-web-docs/src/docs/user/languages/c.mdx +++ b/packages/app-web-docs/src/docs/user/languages/c.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # C diff --git a/packages/app-web-docs/src/docs/user/languages/clojure.mdx b/packages/app-web-docs/src/docs/user/languages/clojure.mdx index fbb26d7c1d..6b51ad24fd 100644 --- a/packages/app-web-docs/src/docs/user/languages/clojure.mdx +++ b/packages/app-web-docs/src/docs/user/languages/clojure.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Clojure diff --git a/packages/app-web-docs/src/docs/user/languages/cpp.mdx b/packages/app-web-docs/src/docs/user/languages/cpp.mdx index 3ae56e716f..5a3a028b39 100644 --- a/packages/app-web-docs/src/docs/user/languages/cpp.mdx +++ b/packages/app-web-docs/src/docs/user/languages/cpp.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # C++ diff --git a/packages/app-web-docs/src/docs/user/languages/csharp.mdx b/packages/app-web-docs/src/docs/user/languages/csharp.mdx index 650f388e75..341cb03e17 100644 --- a/packages/app-web-docs/src/docs/user/languages/csharp.mdx +++ b/packages/app-web-docs/src/docs/user/languages/csharp.mdx @@ -2,7 +2,7 @@ sidebar_label: C# --- -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # C# diff --git a/packages/app-web-docs/src/docs/user/languages/css.mdx b/packages/app-web-docs/src/docs/user/languages/css.mdx index 75f2025d6f..f469005845 100644 --- a/packages/app-web-docs/src/docs/user/languages/css.mdx +++ b/packages/app-web-docs/src/docs/user/languages/css.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # CSS diff --git a/packages/app-web-docs/src/docs/user/languages/dart.mdx b/packages/app-web-docs/src/docs/user/languages/dart.mdx index f39dd7259e..89839b3a97 100644 --- a/packages/app-web-docs/src/docs/user/languages/dart.mdx +++ b/packages/app-web-docs/src/docs/user/languages/dart.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Dart diff --git a/packages/app-web-docs/src/docs/user/languages/go.mdx b/packages/app-web-docs/src/docs/user/languages/go.mdx index d5129adc72..81a5223eae 100644 --- a/packages/app-web-docs/src/docs/user/languages/go.mdx +++ b/packages/app-web-docs/src/docs/user/languages/go.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Go diff --git a/packages/app-web-docs/src/docs/user/languages/html.mdx b/packages/app-web-docs/src/docs/user/languages/html.mdx index b34fb62d4c..e5ca41f1a7 100644 --- a/packages/app-web-docs/src/docs/user/languages/html.mdx +++ b/packages/app-web-docs/src/docs/user/languages/html.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # HTML diff --git a/packages/app-web-docs/src/docs/user/languages/java.mdx b/packages/app-web-docs/src/docs/user/languages/java.mdx index ac34160487..d2a3f0461f 100644 --- a/packages/app-web-docs/src/docs/user/languages/java.mdx +++ b/packages/app-web-docs/src/docs/user/languages/java.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Java diff --git a/packages/app-web-docs/src/docs/user/languages/javascript.mdx b/packages/app-web-docs/src/docs/user/languages/javascript.mdx index 29ebbd9448..f1787df969 100644 --- a/packages/app-web-docs/src/docs/user/languages/javascript.mdx +++ b/packages/app-web-docs/src/docs/user/languages/javascript.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # JavaScript diff --git a/packages/app-web-docs/src/docs/user/languages/javascriptreact.mdx b/packages/app-web-docs/src/docs/user/languages/javascriptreact.mdx index c12ab5b368..8d837d8dd6 100644 --- a/packages/app-web-docs/src/docs/user/languages/javascriptreact.mdx +++ b/packages/app-web-docs/src/docs/user/languages/javascriptreact.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # JavaScript React diff --git a/packages/app-web-docs/src/docs/user/languages/json.mdx b/packages/app-web-docs/src/docs/user/languages/json.mdx index 7a15abe8b6..672c916559 100644 --- a/packages/app-web-docs/src/docs/user/languages/json.mdx +++ b/packages/app-web-docs/src/docs/user/languages/json.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # JSON diff --git a/packages/app-web-docs/src/docs/user/languages/jsonc.mdx b/packages/app-web-docs/src/docs/user/languages/jsonc.mdx index 70de3cb1d2..5d1037816e 100644 --- a/packages/app-web-docs/src/docs/user/languages/jsonc.mdx +++ b/packages/app-web-docs/src/docs/user/languages/jsonc.mdx @@ -2,7 +2,7 @@ sidebar_label: JSONC --- -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # JSON with comments (JSONC) diff --git a/packages/app-web-docs/src/docs/user/languages/jsonl.mdx b/packages/app-web-docs/src/docs/user/languages/jsonl.mdx index e508178163..73a70602b3 100644 --- a/packages/app-web-docs/src/docs/user/languages/jsonl.mdx +++ b/packages/app-web-docs/src/docs/user/languages/jsonl.mdx @@ -2,7 +2,7 @@ sidebar_label: JSONL --- -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # JSON lines (JSONL) diff --git a/packages/app-web-docs/src/docs/user/languages/kotlin.mdx b/packages/app-web-docs/src/docs/user/languages/kotlin.mdx index 501571d2ed..470cd1c90f 100644 --- a/packages/app-web-docs/src/docs/user/languages/kotlin.mdx +++ b/packages/app-web-docs/src/docs/user/languages/kotlin.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Kotlin diff --git a/packages/app-web-docs/src/docs/user/languages/latex.mdx b/packages/app-web-docs/src/docs/user/languages/latex.mdx index c0e80dd492..4ec19bb54e 100644 --- a/packages/app-web-docs/src/docs/user/languages/latex.mdx +++ b/packages/app-web-docs/src/docs/user/languages/latex.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Latex diff --git a/packages/app-web-docs/src/docs/user/languages/lua.mdx b/packages/app-web-docs/src/docs/user/languages/lua.mdx index c6bcf6a234..2523a1c764 100644 --- a/packages/app-web-docs/src/docs/user/languages/lua.mdx +++ b/packages/app-web-docs/src/docs/user/languages/lua.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Lua diff --git a/packages/app-web-docs/src/docs/user/languages/markdown.mdx b/packages/app-web-docs/src/docs/user/languages/markdown.mdx index 6336721323..a546f6910a 100644 --- a/packages/app-web-docs/src/docs/user/languages/markdown.mdx +++ b/packages/app-web-docs/src/docs/user/languages/markdown.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Markdown diff --git a/packages/app-web-docs/src/docs/user/languages/php.mdx b/packages/app-web-docs/src/docs/user/languages/php.mdx index 82dd70efd1..7b627d3cd4 100644 --- a/packages/app-web-docs/src/docs/user/languages/php.mdx +++ b/packages/app-web-docs/src/docs/user/languages/php.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # PHP diff --git a/packages/app-web-docs/src/docs/user/languages/plaintext.mdx b/packages/app-web-docs/src/docs/user/languages/plaintext.mdx index c956a7603c..c1df1f5412 100644 --- a/packages/app-web-docs/src/docs/user/languages/plaintext.mdx +++ b/packages/app-web-docs/src/docs/user/languages/plaintext.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Plaintext diff --git a/packages/app-web-docs/src/docs/user/languages/properties.mdx b/packages/app-web-docs/src/docs/user/languages/properties.mdx index 3f894dbaca..5928c03f34 100644 --- a/packages/app-web-docs/src/docs/user/languages/properties.mdx +++ b/packages/app-web-docs/src/docs/user/languages/properties.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Properties diff --git a/packages/app-web-docs/src/docs/user/languages/python.mdx b/packages/app-web-docs/src/docs/user/languages/python.mdx index 3b62a38834..00d9f1f6cb 100644 --- a/packages/app-web-docs/src/docs/user/languages/python.mdx +++ b/packages/app-web-docs/src/docs/user/languages/python.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Python diff --git a/packages/app-web-docs/src/docs/user/languages/r.mdx b/packages/app-web-docs/src/docs/user/languages/r.mdx index 816cd4b9e0..654c7c8b1f 100644 --- a/packages/app-web-docs/src/docs/user/languages/r.mdx +++ b/packages/app-web-docs/src/docs/user/languages/r.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # R diff --git a/packages/app-web-docs/src/docs/user/languages/ruby.mdx b/packages/app-web-docs/src/docs/user/languages/ruby.mdx index 1ff711b831..1aaa234fe1 100644 --- a/packages/app-web-docs/src/docs/user/languages/ruby.mdx +++ b/packages/app-web-docs/src/docs/user/languages/ruby.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Ruby diff --git a/packages/app-web-docs/src/docs/user/languages/rust.mdx b/packages/app-web-docs/src/docs/user/languages/rust.mdx index 1aa6990171..1ad8ccc3e2 100644 --- a/packages/app-web-docs/src/docs/user/languages/rust.mdx +++ b/packages/app-web-docs/src/docs/user/languages/rust.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Rust diff --git a/packages/app-web-docs/src/docs/user/languages/scala.mdx b/packages/app-web-docs/src/docs/user/languages/scala.mdx index 09a4ead8f8..51fece1f3e 100644 --- a/packages/app-web-docs/src/docs/user/languages/scala.mdx +++ b/packages/app-web-docs/src/docs/user/languages/scala.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Scala diff --git a/packages/app-web-docs/src/docs/user/languages/scm.mdx b/packages/app-web-docs/src/docs/user/languages/scm.mdx index eb33cc9192..9bd4094422 100644 --- a/packages/app-web-docs/src/docs/user/languages/scm.mdx +++ b/packages/app-web-docs/src/docs/user/languages/scm.mdx @@ -2,7 +2,7 @@ sidebar_label: Tree sitter query --- -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Tree sitter query (SCM) diff --git a/packages/app-web-docs/src/docs/user/languages/scss.mdx b/packages/app-web-docs/src/docs/user/languages/scss.mdx index e2fc684299..f791cc75ac 100644 --- a/packages/app-web-docs/src/docs/user/languages/scss.mdx +++ b/packages/app-web-docs/src/docs/user/languages/scss.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # SCSS diff --git a/packages/app-web-docs/src/docs/user/languages/talon-list.mdx b/packages/app-web-docs/src/docs/user/languages/talon-list.mdx index b7ba662726..4fc01d3034 100644 --- a/packages/app-web-docs/src/docs/user/languages/talon-list.mdx +++ b/packages/app-web-docs/src/docs/user/languages/talon-list.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Talon-list diff --git a/packages/app-web-docs/src/docs/user/languages/talon.mdx b/packages/app-web-docs/src/docs/user/languages/talon.mdx index 69209c6ab7..f94f97444e 100644 --- a/packages/app-web-docs/src/docs/user/languages/talon.mdx +++ b/packages/app-web-docs/src/docs/user/languages/talon.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Talon diff --git a/packages/app-web-docs/src/docs/user/languages/typescript.mdx b/packages/app-web-docs/src/docs/user/languages/typescript.mdx index 78766ac48c..0b272ee511 100644 --- a/packages/app-web-docs/src/docs/user/languages/typescript.mdx +++ b/packages/app-web-docs/src/docs/user/languages/typescript.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # TypeScript diff --git a/packages/app-web-docs/src/docs/user/languages/typescriptreact.mdx b/packages/app-web-docs/src/docs/user/languages/typescriptreact.mdx index aca33c37f8..10b6aa61a5 100644 --- a/packages/app-web-docs/src/docs/user/languages/typescriptreact.mdx +++ b/packages/app-web-docs/src/docs/user/languages/typescriptreact.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # TypeScript React diff --git a/packages/app-web-docs/src/docs/user/languages/xml.mdx b/packages/app-web-docs/src/docs/user/languages/xml.mdx index 405b5f6fec..9e4d37f3ad 100644 --- a/packages/app-web-docs/src/docs/user/languages/xml.mdx +++ b/packages/app-web-docs/src/docs/user/languages/xml.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # XML diff --git a/packages/app-web-docs/src/docs/user/languages/yaml.mdx b/packages/app-web-docs/src/docs/user/languages/yaml.mdx index b6eb6db912..63e1f6d33f 100644 --- a/packages/app-web-docs/src/docs/user/languages/yaml.mdx +++ b/packages/app-web-docs/src/docs/user/languages/yaml.mdx @@ -1,4 +1,4 @@ -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # Yaml diff --git a/packages/app-web-docs/src/docs/user/localCommandHIstory.md b/packages/app-web-docs/src/docs/user/local-command-history.md similarity index 100% rename from packages/app-web-docs/src/docs/user/localCommandHIstory.md rename to packages/app-web-docs/src/docs/user/local-command-history.md diff --git a/packages/app-web-docs/src/docs/user/modifiers/_category_.json b/packages/app-web-docs/src/docs/user/modifiers/_category_.json new file mode 100644 index 0000000000..bc1ec70d2f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/modifiers/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Modifiers" +} diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx b/packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx rename to packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx rename to packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/endOf.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx rename to packages/app-web-docs/src/docs/user/modifiers/endOf.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx rename to packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx b/packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx rename to packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx rename to packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx rename to packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx b/packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx rename to packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx b/packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx rename to packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx b/packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx rename to packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx b/packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx rename to packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx b/packages/app-web-docs/src/docs/user/modifiers/leading.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx rename to packages/app-web-docs/src/docs/user/modifiers/leading.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx rename to packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx rename to packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/startOf.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx rename to packages/app-web-docs/src/docs/user/modifiers/startOf.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx b/packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx rename to packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx b/packages/app-web-docs/src/docs/user/modifiers/trailing.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx rename to packages/app-web-docs/src/docs/user/modifiers/trailing.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx b/packages/app-web-docs/src/docs/user/modifiers/visible.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx rename to packages/app-web-docs/src/docs/user/modifiers/visible.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/_category_.json b/packages/app-web-docs/src/docs/user/reference/_category_.json deleted file mode 100644 index d8f1714e59..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Reference", - "collapsed": false, - "position": 2 -} diff --git a/packages/app-web-docs/src/docs/user/reference/actions/_category_.json b/packages/app-web-docs/src/docs/user/reference/actions/_category_.json deleted file mode 100644 index c81c210e7f..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Actions", - "position": 1 -} diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json b/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json deleted file mode 100644 index 0f5ce9207f..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Modifiers", - "position": 2 -} diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json b/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json deleted file mode 100644 index da14614c2d..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Scopes", - "position": 3 -} diff --git a/packages/app-web-docs/src/docs/user/release-notes/0.28.0.md b/packages/app-web-docs/src/docs/user/release-notes/0.28.0.md index b3709657a6..6829814604 100644 --- a/packages/app-web-docs/src/docs/user/release-notes/0.28.0.md +++ b/packages/app-web-docs/src/docs/user/release-notes/0.28.0.md @@ -29,7 +29,7 @@ But here are some highlights: - `"sentence"` ([video 🎬](https://youtu.be/rdLH2GKJirE)) ([#1595](https://github.com/cursorless-dev/cursorless/pull/1595)) - Added [the scope visualizer](../scope-visualizer.md) ([#1653](https://github.com/cursorless-dev/cursorless/pull/1653)) to let you visualize scopes live in your editor ([video 🎬](https://youtu.be/BbXEzUrf5lU)). And here's a screenshot ![Scope visualizer](../images/visualize-funk.png) - A next-gen inference engine that enables a much more powerful grammar, allowing you to do things like individually targeting a sequence of scopes, eg `"every line air past bat"`. To learn more, see the initial [#1462](https://github.com/cursorless-dev/cursorless/pull/1462), and then the follow-up [#1463](https://github.com/cursorless-dev/cursorless/pull/1463) if you're addicted to 🤯. Note that this grammar only works for our next-gen scopes, which include most generic scopes (`"line"`, `"token"`, `"word"`, `"character"`, `"block"`), as well as some language-specific scopes. We still have a lot of language-specific scopes to upgrade, as the infrastructure to do so is still quite new. Stay tuned -- [Stable hats](../hatAssignment.md) ([#1252](https://github.com/cursorless-dev/cursorless/pull/1252)) keep hats from moving around so much while you edit. This change is something you may or may not have consciously noticed, but if you spontaneously experienced a deep feeling of oneness and calm at some point in the past six months, the newly meditative hats might have been the cause 🎩🧘 +- [Stable hats](../hat-assignment.md) ([#1252](https://github.com/cursorless-dev/cursorless/pull/1252)) keep hats from moving around so much while you edit. This change is something you may or may not have consciously noticed, but if you spontaneously experienced a deep feeling of oneness and calm at some point in the past six months, the newly meditative hats might have been the cause 🎩🧘 - Improved support for very large hats. A trend among users has been to slightly increase their line height (eg 1.6) and then use a very large hat size (eg 70) to make the hats more visible. This works great, but adjacent hats would overlap. Now, we automatically detect clashing hats and stop them from growing horizontally if they'd overlap ([#1687](https://github.com/cursorless-dev/cursorless/pull/1687)). @pokey is now running with a line height of 1.6 and a hat size of 70, after getting serious hat-size envy during some user screenshares on discord 👒.![Big hats](big-hats.png) If you want to join the big hat revolution, say `"show settings say line height"` to mess with your line height, then `"cursorless settings"` to mess with your hat size - Lots of improvements to our Go language support (thanks [@josharian](https://github.com/josharian)!) - Expanded our [Talon-side custom API](../customization.md#public-talon-actions) to diff --git a/packages/app-web-docs/src/docs/user/release-notes/_category_.json b/packages/app-web-docs/src/docs/user/release-notes/_category_.json new file mode 100644 index 0000000000..0fc9c0f9d8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/release-notes/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Release notes" +} diff --git a/packages/app-web-docs/src/docs/user/scope-sidebar.md b/packages/app-web-docs/src/docs/user/scope-sidebar.md index bf015bb95e..f134c9e932 100644 --- a/packages/app-web-docs/src/docs/user/scope-sidebar.md +++ b/packages/app-web-docs/src/docs/user/scope-sidebar.md @@ -1,4 +1,4 @@ -# The Cursorless sidebar +# Cursorless sidebar You can say `"bar cursorless"` to show the Cursorless sidebar. diff --git a/packages/app-web-docs/src/docs/user/scopes/_category_.json b/packages/app-web-docs/src/docs/user/scopes/_category_.json new file mode 100644 index 0000000000..b81a227cbb --- /dev/null +++ b/packages/app-web-docs/src/docs/user/scopes/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Scopes" +} diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx b/packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx rename to packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx b/packages/app-web-docs/src/docs/user/scopes/argumentList.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx rename to packages/app-web-docs/src/docs/user/scopes/argumentList.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx b/packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx rename to packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx b/packages/app-web-docs/src/docs/user/scopes/attribute.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx rename to packages/app-web-docs/src/docs/user/scopes/attribute.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx rename to packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx rename to packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx b/packages/app-web-docs/src/docs/user/scopes/branch.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx rename to packages/app-web-docs/src/docs/user/scopes/branch.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx b/packages/app-web-docs/src/docs/user/scopes/chapter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx rename to packages/app-web-docs/src/docs/user/scopes/chapter.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx b/packages/app-web-docs/src/docs/user/scopes/character.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/character.mdx rename to packages/app-web-docs/src/docs/user/scopes/character.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx b/packages/app-web-docs/src/docs/user/scopes/class.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/class.mdx rename to packages/app-web-docs/src/docs/user/scopes/class.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx b/packages/app-web-docs/src/docs/user/scopes/className.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/className.mdx rename to packages/app-web-docs/src/docs/user/scopes/className.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx b/packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx rename to packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx b/packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx rename to packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx b/packages/app-web-docs/src/docs/user/scopes/command.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/command.mdx rename to packages/app-web-docs/src/docs/user/scopes/command.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx b/packages/app-web-docs/src/docs/user/scopes/comment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx rename to packages/app-web-docs/src/docs/user/scopes/comment.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx b/packages/app-web-docs/src/docs/user/scopes/condition.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx rename to packages/app-web-docs/src/docs/user/scopes/condition.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx b/packages/app-web-docs/src/docs/user/scopes/document.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/document.mdx rename to packages/app-web-docs/src/docs/user/scopes/document.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx b/packages/app-web-docs/src/docs/user/scopes/environment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx rename to packages/app-web-docs/src/docs/user/scopes/environment.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/user/scopes/fullLine.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx rename to packages/app-web-docs/src/docs/user/scopes/fullLine.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx b/packages/app-web-docs/src/docs/user/scopes/functionCall.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx rename to packages/app-web-docs/src/docs/user/scopes/functionCall.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx b/packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx rename to packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx b/packages/app-web-docs/src/docs/user/scopes/functionName.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx rename to packages/app-web-docs/src/docs/user/scopes/functionName.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx b/packages/app-web-docs/src/docs/user/scopes/glyph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx rename to packages/app-web-docs/src/docs/user/scopes/glyph.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx b/packages/app-web-docs/src/docs/user/scopes/identifier.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx rename to packages/app-web-docs/src/docs/user/scopes/identifier.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx b/packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx rename to packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx b/packages/app-web-docs/src/docs/user/scopes/instance.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx rename to packages/app-web-docs/src/docs/user/scopes/instance.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx b/packages/app-web-docs/src/docs/user/scopes/line.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/line.mdx rename to packages/app-web-docs/src/docs/user/scopes/line.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx b/packages/app-web-docs/src/docs/user/scopes/list.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/list.mdx rename to packages/app-web-docs/src/docs/user/scopes/list.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx b/packages/app-web-docs/src/docs/user/scopes/map.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/map.mdx rename to packages/app-web-docs/src/docs/user/scopes/map.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx b/packages/app-web-docs/src/docs/user/scopes/name.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/name.mdx rename to packages/app-web-docs/src/docs/user/scopes/name.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx b/packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx rename to packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx rename to packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx rename to packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx b/packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx rename to packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx b/packages/app-web-docs/src/docs/user/scopes/paragraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx rename to packages/app-web-docs/src/docs/user/scopes/paragraph.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx b/packages/app-web-docs/src/docs/user/scopes/part.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/part.mdx rename to packages/app-web-docs/src/docs/user/scopes/part.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx b/packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx rename to packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx b/packages/app-web-docs/src/docs/user/scopes/section.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/section.mdx rename to packages/app-web-docs/src/docs/user/scopes/section.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx rename to packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx b/packages/app-web-docs/src/docs/user/scopes/selector.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx rename to packages/app-web-docs/src/docs/user/scopes/selector.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx b/packages/app-web-docs/src/docs/user/scopes/sentence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx rename to packages/app-web-docs/src/docs/user/scopes/sentence.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx b/packages/app-web-docs/src/docs/user/scopes/statement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx rename to packages/app-web-docs/src/docs/user/scopes/statement.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx rename to packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx b/packages/app-web-docs/src/docs/user/scopes/subSection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx rename to packages/app-web-docs/src/docs/user/scopes/subSection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx b/packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx rename to packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx b/packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx rename to packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx b/packages/app-web-docs/src/docs/user/scopes/token.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/token.mdx rename to packages/app-web-docs/src/docs/user/scopes/token.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx b/packages/app-web-docs/src/docs/user/scopes/type.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/type.mdx rename to packages/app-web-docs/src/docs/user/scopes/type.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx b/packages/app-web-docs/src/docs/user/scopes/unit.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx rename to packages/app-web-docs/src/docs/user/scopes/unit.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx b/packages/app-web-docs/src/docs/user/scopes/url.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/url.mdx rename to packages/app-web-docs/src/docs/user/scopes/url.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx b/packages/app-web-docs/src/docs/user/scopes/value.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/value.mdx rename to packages/app-web-docs/src/docs/user/scopes/value.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx b/packages/app-web-docs/src/docs/user/scopes/word.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/word.mdx rename to packages/app-web-docs/src/docs/user/scopes/word.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx rename to packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx rename to packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx rename to packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx rename to packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx diff --git a/packages/app-web-docs/src/docs/user/unicode.md b/packages/app-web-docs/src/docs/user/unicode-support.md similarity index 99% rename from packages/app-web-docs/src/docs/user/unicode.md rename to packages/app-web-docs/src/docs/user/unicode-support.md index a8680e88f4..1ce163c613 100644 --- a/packages/app-web-docs/src/docs/user/unicode.md +++ b/packages/app-web-docs/src/docs/user/unicode-support.md @@ -1,4 +1,4 @@ -# Unicode +# Unicode support Cursorless has first-class support for Unicode. By default, when constructing hats, Cursorless will ignore capitalization and any accents or diacritics over letters. For example, each of the following four tokens could each be selected by saying `"take air"` if there were a gray hat over their first letter (note the accents on the first letter for some of them): diff --git a/packages/app-web-docs/src/docs/user/visualAccessibility.md b/packages/app-web-docs/src/docs/user/visual-accessibility.md similarity index 100% rename from packages/app-web-docs/src/docs/user/visualAccessibility.md rename to packages/app-web-docs/src/docs/user/visual-accessibility.md diff --git a/packages/lib-engine/src/util/allocateHats/allocateHats.ts b/packages/lib-engine/src/util/allocateHats/allocateHats.ts index 534dd1f9b8..d733d599ac 100644 --- a/packages/lib-engine/src/util/allocateHats/allocateHats.ts +++ b/packages/lib-engine/src/util/allocateHats/allocateHats.ts @@ -41,7 +41,7 @@ interface AllocateHatsOptions { * a hat to each one in turn, deciding whether to keep old hat, steal a hat from * another token, or use a freely available hat. * - * See [hat assignment](/docs/user/hatAssignment) for more info. + * See [hat assignment](/docs/user/hat-assignment) for more info. * * @param tokenGraphemeSplitter Splits tokens into graphemes * @param enabledHatStyles A list of all enabled hat styles diff --git a/packages/lib-engine/src/util/allocateHats/chooseTokenHat.ts b/packages/lib-engine/src/util/allocateHats/chooseTokenHat.ts index 222af605d6..c0c70bec3b 100644 --- a/packages/lib-engine/src/util/allocateHats/chooseTokenHat.ts +++ b/packages/lib-engine/src/util/allocateHats/chooseTokenHat.ts @@ -24,7 +24,7 @@ import { maxByFirstDiffering } from "./maxByFirstDiffering"; * already taken it * 2. Decide whether to steal a hat from a lower ranked token * - * See [hat assignment](/docs/user/hatAssignment) for more info. + * See [hat assignment](/docs/user/hat-assignment) for more info. * * FIXME: Could be improved by ignoring subsequent tokens that also contain * another character that can be used with lower color. To compute that, look at diff --git a/packages/tool-meta-updater/src/metaUpdater.ts b/packages/tool-meta-updater/src/metaUpdater.ts index 231ca7529f..dd773f704c 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -37,14 +37,13 @@ export const updater = async (workspaceDir: string) => { const userDir = "src/docs/user"; const contributingDir = "src/docs/contributing"; - const referenceDir = `${userDir}/reference`; return createUpdateOptions({ files: { "package.json": updatePackageJson.bind(null, context), "tsconfig.json": updateTSConfig.bind(null, context), "tsconfig.base.json": updateTSConfigBase.bind(null, context), - "resources/fixtures/scopeSupportFacetInfos.md": + "resources/fixtures/scope-support-facet-infos.md": updatesScopeSupportFacetInfos, ...Object.fromEntries( Object.keys(languageScopeSupport).map((languageId) => [ @@ -54,25 +53,25 @@ export const updater = async (workspaceDir: string) => { ), ...Object.fromEntries( Object.entries(actionReferences).map(([id, entry]) => [ - `${referenceDir}/actions/${cleanId(id)}.mdx`, + `${userDir}/actions/${cleanId(id)}.mdx`, updateReferenceMdx.bind(null, "action", id, entry), ]), ), ...Object.fromEntries( Object.entries(modifierReferences).map(([id, entry]) => [ - `${referenceDir}/modifiers/${cleanId(id)}.mdx`, + `${userDir}/modifiers/${cleanId(id)}.mdx`, updateReferenceMdx.bind(null, "modifier", id, entry), ]), ), ...Object.fromEntries( Object.entries(scopeReferences).map(([id, entry]) => [ - `${referenceDir}/scopes/${cleanId(id)}.mdx`, + `${userDir}/scopes/${cleanId(id)}.mdx`, updateReferenceMdx.bind(null, "scope", id, entry), ]), ), ...Object.fromEntries( Object.entries(scopeReferences).map(([id, entry]) => [ - `${contributingDir}/privateScopes/${cleanId(id)}.mdx`, + `${contributingDir}/private-scopes/${cleanId(id)}.mdx`, updatePrivateScopeMdx.bind(null, id, entry), ]), ), diff --git a/packages/tool-meta-updater/src/updateLanguageMdx.ts b/packages/tool-meta-updater/src/updateLanguageMdx.ts index cf1514b6cf..2eee658175 100644 --- a/packages/tool-meta-updater/src/updateLanguageMdx.ts +++ b/packages/tool-meta-updater/src/updateLanguageMdx.ts @@ -15,7 +15,7 @@ export function updateLanguageMdx( } const expected = ` -import { Language } from "./components/Language"; +import { Language } from "@site/src/docs/components/Language"; # ${prettifyLanguageName(languageId)} diff --git a/resources/fixtures/scopeSupportFacetInfos.md b/resources/fixtures/scope-support-facet-infos.md similarity index 100% rename from resources/fixtures/scopeSupportFacetInfos.md rename to resources/fixtures/scope-support-facet-infos.md