From 295bb496e0ebde0e0772843a8c91750ec95b4a96 Mon Sep 17 00:00:00 2001 From: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com> Date: Mon, 12 Aug 2024 15:45:42 -0500 Subject: [PATCH] Delete guides/lint-a-document-with-dx-linter-script.mdx Deleting as per Katies request. --- .../lint-a-document-with-dx-linter-script.mdx | 26 ------------------- 1 file changed, 26 deletions(-) delete mode 100644 guides/lint-a-document-with-dx-linter-script.mdx diff --git a/guides/lint-a-document-with-dx-linter-script.mdx b/guides/lint-a-document-with-dx-linter-script.mdx deleted file mode 100644 index 45aa737c6..000000000 --- a/guides/lint-a-document-with-dx-linter-script.mdx +++ /dev/null @@ -1,26 +0,0 @@ -# How to lint a document with the DX linter script - -The Developer Documentation team uses a custom script to lint your doc files before they are pushed. This linter covers everything our in-house Style Guide does, saving you tons of time. - -Run the script using the CLI to get your PR submission nearly perfect in no time. - - - Before running the script, ensure your nvm version is at least 18. You can update the nvm version using the following command: - - `nvm use 18` - - -1. Open terminal and navigate to the file's folder. - -2. Run `npx github:bigcommerce/dev-docs-style-guide-linter ./{{yourfilename}}.mdx.` - -Example: `npx github:bigcommerce/dev-docs-style-guide-linter ./start/authentication/index.mdx` - - - **NOTE:** Ensure your file name has the correct path. - - -3. Review the flagged items and make necessary updates. - -4. Repeat Step 2 to re-run the script. -