Skip to content

Commit a5b4212

Browse files
authored
docs: update documentation contribution guide (#1479)
1 parent ecc4bbe commit a5b4212

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/5-extra-topics/03-contributing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,13 @@ We welcome contributions of any size! Feel free to submit a pull request, even i
5353

5454
To contribute to Tempest's documentation, please:
5555

56-
- Head over to the [Tempest docs repository](https://github.com/tempestphp/tempest-docs) to fork the project.
56+
- [Set up Tempest locally](#setting-up-tempest-locally) and head to `/docs`.
5757
- Add or edit any relevant documentation in a manner consistent with the rest of the documentation.
5858
- Re-read what you wrote and run it through a spell checker.
59+
- Optionally,
60+
- Head over to the [Tempest docs repository](https://github.com/tempestphp/tempest-docs) to fork the project.
61+
- Run `tempest docs:symlink` to link the `/docs` of your local Tempest clone to the documentation website.
62+
- Preview your changes by running `bun run dev`.
5963
- Open a pull request with your changes.
6064

6165
Once a pull request has been opened, the Tempest team will:

0 commit comments

Comments
 (0)