(website) fix: docusaurus broken links and jsdoc @link warning

alichry · Feb 16, 2025 · 6558a88 · 6558a88
1 parent 6fd2de0
commit 6558a88
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 10 deletions.
diff --git a/packages/sst/lib/SstLoader.ts b/packages/sst/lib/SstLoader.ts
@@ -65,8 +65,8 @@ export default class SstLoader extends Loader {
     }
 
     /**
-     * @link https://github.com/serverless-stack/serverless-stack/issues/1115
-     * @param resolver 
+     * {@link https://github.com/serverless-stack/serverless-stack/issues/1115}
+     * @param resolver
      */
     protected addResolver(resolver: ParsedResolverInfo): void {
         let dataSource = "";

diff --git a/website/docs/getting-started/load-resolvers.mdx b/website/docs/getting-started/load-resolvers.mdx
@@ -11,8 +11,8 @@ Up until now, we have not interacted with AppSync Butler. We have
 
 The AppSync construct is not _yet_ aware of the on-disk resolvers. 
 AppSync Butler handles this process seamlessly. To load on-disk
-resolvers and functions, use [`Loader`](/docs/api/classes/appsync_butler_core.Loader) or
-[`SstLoader`](/docs/api/classes/appsync_butler_sst.SstLoader) for CDK and SST applications respectively
+resolvers and functions, use [`Loader`](/docs/api/@appsync-butler/core/classes/Loader) or
+[`SstLoader`](/docs/api/@appsync-butler/sst/classes/SstLoader) for CDK and SST applications respectively
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
@@ -80,5 +80,5 @@ const loader = new Loader(this, { api, defaultUnitResolverDataSource: 'none' });
 }
 ```
 -->
-For other options that you may pass, check [LoaderOptions](/docs/api/#loaderoptions).
+For other options that you may pass, check [CDK:LoaderOptions](/docs/api/@appsync-butler/core/interfaces/LoaderOptions) or [SST:LoaderOptions](/docs/api/@appsync-butler/sst/interfaces/SstLoaderOptions).
 :::
diff --git a/website/docs/getting-started/run-graphql-operations.mdx b/website/docs/getting-started/run-graphql-operations.mdx
@@ -91,6 +91,6 @@ Can you improve the docs? [Please submit a PR!](https://github.com/alichry/appsy
 ## What's next?
 
 - Read the [API documentation](/docs/api)
-- [Define a variable](/docs/api/classes/appsync_butler_core.Parser#setvariable) in your AppSync Mapping Template.
+- [Define a variable](/docs/api/@appsync-butler/core/classes/Parser#setvariable) in your AppSync Mapping Template.
 - Tweet about your experience with AppSync Butler.
 - Looking to contribute? Let's discuss more on [Gitter](https://gitter.im/appsync-butler/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link) to get started.
diff --git a/website/docs/intro.mdx b/website/docs/intro.mdx
@@ -141,12 +141,12 @@ AppSync Butler handles the necessary steps to load this pipeline resolver into A
 AppSync Butler parses mapping templates (request, response, before, after) and
 replaces references of a user-defined variable to its specified value.
 Variables are denoted as `{{ var }}`. Variables are defined during the
-[instantialization of a loader](/docs/api/classes/appsync_butler_core.Loader) or set using
-[`loader.builder.parser.setVariable(key, value)`](/docs/api/classes/appsync_butler_core.Parser#setvariable)
+[instantialization of a loader](/docs/api/@appsync-butler/core/classes/Loader) or set using
+[`loader.builder.parser.setVariable(key, value)`](/docs/api/@appsync-butler/core/classes/Parser#setvariable)
 
 :::danger
 
-AppSync Butler throws an [`UndefinedVariableError`](/docs/api/classes/appsync_butler_core.UndefinedVariableError) if an unrecognized
+AppSync Butler throws an [`UndefinedVariableError`](/docs/api/@appsync-butler/core/classes/UndefinedVariableError) if an unrecognized
 variable is encountered in a mapping template.
 
 :::

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -40,7 +40,8 @@ const config = {
         ],
         entryPointStrategy: 'packages',
         packageOptions: {
-          entryPoints: ["lib/index.ts"]
+          entryPoints: ["lib/index.ts"],
+          readme: "none",
         },
         //tsconfig: '../packages/core/tsconfig.json',
         //watch: process.env.TYPEDOC_WATCH,