Solved Meta main #524

[beingPro007]

solved #524

Added the meta variables in _quarto.yml

and used them here like

Kindly merge this Pull Request

[beingPro007]

@yebai Please review this and if correct then merge this to the master branch

[github-actions]

Preview the changes: https://turinglang.org/docs/pr-previews/530
Please avoid using the search feature and navigation bar in PR previews!

[penelopeysm]

Hi @beingPro007, thanks for working on this 😄

I have a few suggestions for contributing to open source code.

1. Make your commit messages more descriptive. In this case I don't know what 'Meta main 524' is. A better commit message would be Add Quarto variables. If you want to make reference to the GitHub issue, you can write a multiline commit message (note that the hashtag, like #524, is the usual way of referring to a GitHub issue or pull request):

   Add Quarto variables
   
   Closes #524
   

   In this case, the first line is shown to users and when they look more closely (either via git log or via the GitHub web interface) they can see the full message.

   Here's an old, but very good, explanation of what goes into a good commit message: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

2. Most of the changes in this PR are removing trailing whitespace. That's great, but it is a separate matter from the Quarto variables, so would be even better if those were part of a separate commit. So you could have one commit that is just for the variables, and one commit that is just for whitespace. They could both still be part of this PR, but having atomic commits (i.e. one commit that does just one thing) makes it much easier to understand the changes and history of the repository.

3. Use permalinks to refer to code, instead of screenshots. See https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet

   Permalinks let you click through to the actual code in the repository, and are also more accessible than screenshots (which can't be read with eg text-to-speech).

[yebai]

Let us introduce a base URL meta variable to replace .. or ../.. usage across tutorials:

../{{<meta using-turing-autodiff>}}

becomes

 {{<meta doc-base-url>}}/{{<meta using-turing-autodiff>}}

[beingPro007]

@penelopeysm and @yebai I considered this thing as a feedback for this PR and will try to resolve it again and do the following changes as told. Thank you for considering me😁

[penelopeysm]

No problem, feel free to ask if anything is unclear :)

[penelopeysm]

@beingPro007 Did you plan to make any more changes?

If you're done editing, you can request a review at the top-right of the PR screen with the refresh button here:

[penelopeysm]

Yup!

[yebai]

It looks good to me, although I didn't check whether the links actually work!

[penelopeysm]

@yebai I was thinking about maybe introducing a link checker at some point in time to check that the hyperlinks all return 200 :)

[beingPro007]

@yebai I was thinking about maybe introducing a link checker at some point in time to check that the hyperlinks all return 200 :)

Yes, this is a great idea! If possible as it reduces the manual checking of the broken links, we can utilize an external link checker like linkinator or broken link checker in our CI pipelines. Here’s a quick example of how we could implement linkinator in a GitHub Action

on:
  push:
  pull_request:

jobs:
  linkChecker:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Install Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '16'

      - name: Install linkinator
        run: npm install -g linkinator

      - name: Run linkinator
        run: linkinator . --recurse

This configuration checks all links in our project automatically on each push or pull request. Let me know your thoughts!

[penelopeysm]

That's a matter for a separate issue/PR.

[penelopeysm]

(I just did some minor cleanup to get things working nicely.)

Thanks for the contribution, @beingPro007!