Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update rafiki prettier note #61

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Update rafiki prettier note #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions src/content/docs/content/rafiki.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@ import { Card } from '@astrojs/starlight/components';

<Card title="Before committing changes" icon="star">

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
```
</Card>

<Card title="After a Starlight upgrade to rafiki" icon="star">
Expand Down
Loading