# How to see doc page of GitHub PR

**URL:** <https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454>\
**Category:** General Usage\
**Tags:** documentation, github\
**Created:** [October 26, 2023, 6:30pm UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454 "2023-10-26T18:30:33Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![Torkel](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/torkel/32/5030_2.png) [@Torkel](https://discourse.julialang.org/u/Torkel)\
**Post date:** [October 26, 2023, 6:30pm UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454/1 "2023-10-26T18:30:33Z")

</div>

Have asked people this, but cannot find it anywhere using search functions.

I have a PR to a Julia package hosted on GitHub (with documentation produced in, what I think is, the normal Julia way): [General doc update by TorkelE · Pull Request #706 · SciML/Catalyst.jl · GitHub](https://github.com/SciML/Catalyst.jl/pull/706)

There is some way to see the documentation that would be produced by this PR (by writing the correct URL), but what is it?

---

<div class="post-metadata">

**Author:** ![Nathan\_Boyer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/nathan_boyer/32/14825_2.png) [@Nathan\_Boyer](https://discourse.julialang.org/u/Nathan_Boyer)\
**Post date:** [October 26, 2023, 7:05pm UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454/2 "2023-10-26T19:05:09Z")

</div>

I would also like to know if there is a better way e.g. to check that references and links work. The only method I know of is to “view” the markdown files on Github.

From your link:

1. ![image](https://global.discourse-cdn.com/julialang/original/3X/1/f/1fc8ed20b45fca841b165e7852dc7cb06e958ddb.png)
2. Click “View file” under the three dots dropdown.  
 ![image](https://global.discourse-cdn.com/julialang/original/3X/0/8/086cc65f915c78d0158ab3a7ffd16414bfcc8703.png)
3. Copy the link to that webpage e.g.  
[Catalyst.jl/docs/src/catalyst\_applications/advanced\_simulations.md at 6980635902d987df712a06da39c32585500c6e25 · SciML/Catalyst.jl (github.com)](https://github.com/SciML/Catalyst.jl/blob/6980635902d987df712a06da39c32585500c6e25/docs/src/catalyst_applications/advanced_simulations.md)

---

<div class="post-metadata">

**Author:** ![gdalle](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/gdalle/32/27854_2.png) [@gdalle](https://discourse.julialang.org/u/gdalle)\
**Post date:** [October 27, 2023, 6:38am UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454/3 "2023-10-27T06:38:18Z")

</div>

The most reliable way is to build the documentation yourself locally:

```julia
using Pkg
Pkg.activate("docs")
include("docs/make.jl")

```

and then open the `docs/build/index.html` file in your favorite browser.

If it’s a repo you have access to, you can also activate PR docs preview with the `push_preview` argument to [`Documenter.deploydocs`](https://documenter.juliadocs.org/stable/lib/public/#Documenter.deploydocs). But it will only work for repo insiders, not for PRs that come from a fork

---

<div class="post-metadata">

**Author:** ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Post date:** [October 27, 2023, 7:33am UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454/4 "2023-10-27T07:33:46Z")

</div>

If you click on the `documenter/deploy` commit status it takes you to the preview.

In your case it looks like Documenter managed to push the files, but it didn’t trigger GitHubs build and deploy. Most likely you haven’t set up the SSH deploy key correctly.

---

<div class="post-metadata">

**Author:** ![Torkel](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/torkel/32/5030_2.png) [@Torkel](https://discourse.julialang.org/u/Torkel)\
**Post date:** [October 27, 2023, 2:59pm UTC](https://discourse.julialang.org/t/how-to-see-doc-page-of-github-pr/105454/5 "2023-10-27T14:59:16Z")

</div>

Thanks everyone, this was all really useful 🙂