Skip to content
Snippets Groups Projects
  1. Jan 30, 2023
    • Matt Wang's avatar
      docs: label new features introduced in `v0.4` (#1138) · 5f91e326
      Matt Wang authored
      In #1058, I noted:
      
      > Tangentially related work:
      > ...
      > - better annotate new features (motivated by writing these docs)
      >     - we should add "New" to new features :) 
      >     - we should note when a feature was introduced (I think this is a core part of most software documentation)
      >     - we should annotate things that are "Advanced" in so far as the average Just the Docs user will not use them / they require significant Jekyll knowledge
      > 
      
      This came up again in https://github.com/just-the-docs/just-the-docs/discussions/1136#discussioncomment-4716253, so I think it's best for us to resolve this sooner rather than later.
      
      This PR is me doing that. I:
      
      - have added a headings-level "New" label to every new heading introduced since `v0.3`
      - added, when possible, inline YAML comments when new configuration options have been introduced
      
      I did this by scanning through the CHANGELOG and selecting each feature that is either tagged with `Add` and has documentation.
      
      I may have also missed any new features, so some double-checking would be helpful!
      Unverified
      5f91e326
  2. Jan 13, 2023
    • Matt Wang's avatar
      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.
      Unverified
      a789198b
  3. Sep 11, 2022
  4. Jul 04, 2022
Loading