Skip to content

Commit 86620ef

Browse files
fix: Update README with PR preview link information (#1837)
Co-authored-by: Devin Logan <[email protected]>
1 parent b02d401 commit 86620ef

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before you begin, make sure you have the following installed:
2323
cd docs
2424
```
2525

26-
### Local development
26+
### Editing documentation
2727

2828
To run the documentation site locally:
2929

@@ -39,6 +39,9 @@ To run the documentation site locally:
3939

4040
The development server will automatically reload when you make changes to the documentation files.
4141

42+
Finally, when you make a PR to update the docs, a PR preview link will be generated which will allow you
43+
to test if your changes came out as intended. [Here](https://github.com/fern-api/docs/pull/1784) is a sample PR with a preview link.
44+
4245
## Contribution guide
4346

4447
Thanks for contributing to Fern's documentation!
@@ -117,4 +120,4 @@ If you want to **add a new page or make a large structural change**:
117120
For **all other changes**:
118121
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
119122

120-
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi).
123+
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi).

0 commit comments

Comments
 (0)