From ccc051fb51f50edbec20e764562aff13dc92e6f9 Mon Sep 17 00:00:00 2001 From: Melissa Henderson <57110301+melissahenderson@users.noreply.github.com> Date: Mon, 6 Jan 2025 13:37:09 -0500 Subject: [PATCH] Update rafiki prettier note --- src/content/docs/content/rafiki.mdx | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/content/docs/content/rafiki.mdx b/src/content/docs/content/rafiki.mdx index 254c8da..4d54521 100644 --- a/src/content/docs/content/rafiki.mdx +++ b/src/content/docs/content/rafiki.mdx @@ -6,18 +6,19 @@ import { Card } from '@astrojs/starlight/components'; -Your PR title must contain the appropriate prefix (probably `docs:`). +1. Your PR title must contain the appropriate prefix (`docs:`). -:::caution[Before committing changes] -As of November 2024, we should run the following command in the **root**. +2. Run the following command within the `/packages/documentation` directory: -``` -pnpm format -``` + ``` + npx prettier . --write + ``` -Running this command from the `/packages/documentation` directory will blow up our manually formatted tables. Until Sarah has a good solution for us, running the command from the root will skip the `documentation` folder, which we want. -::: + You can also try the following. It might work, or you might get an error. + ``` + pnpm format + ```