Skip to content
Snippets Groups Projects
  • Matt Wang's avatar
    a789198b
    docs: fix broken relative page links (#1106) · a789198b
    Matt Wang authored
    In touching up the migration guide, I noticed that many of our documentation site links are broken! For example, on the homepage, this link:
    
    <img width="782" alt="screenshot of homepage; code snippet is in next block" src="https://user-images.githubusercontent.com/14893287/210462690-31aa7bf5-dd79-4e8f-a3c5-1213e73771c4.png">
    
    which has the following href
    
    ```code
    <a href="/just-the-docs/just-the-docs/CHANGELOG/">the CHANGELOG</a>
    ```
    
    duplicates the `baseurl` twice. There are 14 such broken links across the site. Each link duplicates the `baseurl` and `link` tags, which has since been resolved with links being relative by default (there's a set of PRs that document this - I can't find the exact paper trail right now).
    
    To resolve this, I:
    
    - find and replace site-wide `{{ site.baseurl }}{% link` with `{% link`
    - tested each link, which now works properly locally *and* on the deploy preview
    
    I'm surprised we didn't catch this earlier! I also could be missing something else, in which case feedback on this PR is certainly welcome.
    docs: fix broken relative page links (#1106)
    Matt Wang authored
    In touching up the migration guide, I noticed that many of our documentation site links are broken! For example, on the homepage, this link:
    
    <img width="782" alt="screenshot of homepage; code snippet is in next block" src="https://user-images.githubusercontent.com/14893287/210462690-31aa7bf5-dd79-4e8f-a3c5-1213e73771c4.png">
    
    which has the following href
    
    ```code
    <a href="/just-the-docs/just-the-docs/CHANGELOG/">the CHANGELOG</a>
    ```
    
    duplicates the `baseurl` twice. There are 14 such broken links across the site. Each link duplicates the `baseurl` and `link` tags, which has since been resolved with links being relative by default (there's a set of PRs that document this - I can't find the exact paper trail right now).
    
    To resolve this, I:
    
    - find and replace site-wide `{{ site.baseurl }}{% link` with `{% link`
    - tested each link, which now works properly locally *and* on the deploy preview
    
    I'm surprised we didn't catch this earlier! I also could be missing something else, in which case feedback on this PR is certainly welcome.