Skip to content

Commit

Permalink
DOCS: Document how to view the GitBook previews created for each PR (#…
Browse files Browse the repository at this point in the history
…2780)

Co-authored-by: Tom Limoncelli <[email protected]>
  • Loading branch information
cafferata and tlimoncelli authored Jan 10, 2024
1 parent 3f6b93e commit 858c902
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
Binary file not shown.
14 changes: 12 additions & 2 deletions documentation/styleguide-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,19 @@ parameter_types:
* `parameter_types`: The typescript type for each parameter. This is used when generating `types-dnscontrol.d.ts`
* `provider`: If a feature is only available for one provider

## Documentation previews
## GitHub pull request preview

> "Preview links are only accessible by GitBook users. We're working on a feature that will allow preview links to be viewable by anyone who accesses the PR." — _[GitBook](https://docs.gitbook.com/product-tour/git-sync/github-pull-request-preview#how-to-access-preview-links)_
When you submit a GitHub pull request, you can view the result in advance. This allows you to check the impact of changes.

![](assets/styleguide-doc/pull-request-preview.webp)

### How to access preview links

For every pull request, you’ll see a status added to the GitHub pull request with a unique preview URL. Clicking the **Details** link on the status will take you to the preview URL for your content. You can then make sure the content is as expected.

{% hint style="info" %}
**NOTE**: A new preview URL is created for every git update. Please check the GitHub status for the most up to date URL.
{% endhint %}

## Formatting tips

Expand Down

0 comments on commit 858c902

Please sign in to comment.