diff --git a/.github/workflows/check_markup_links.yml b/.github/workflows/check_markup_links.yml new file mode 100644 index 0000000000..66b04876f6 --- /dev/null +++ b/.github/workflows/check_markup_links.yml @@ -0,0 +1,19 @@ +name: Check markup links +on: + pull_request: + branches: + - main + workflow_dispatch: +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1 + with: + folder-path: 'docs' + file-path: README.md + check-modified-files-only: yes + base-branch: main + use-quiet-mode: yes + use-verbose-mode: yes diff --git a/docs/lang/articles/reference/differences_between_taichi_and_python_programs.md b/docs/lang/articles/reference/differences_between_taichi_and_python_programs.md index 9a41c797ac..cb8bc4cabe 100644 --- a/docs/lang/articles/reference/differences_between_taichi_and_python_programs.md +++ b/docs/lang/articles/reference/differences_between_taichi_and_python_programs.md @@ -6,7 +6,7 @@ sidebar_position: 5 Although Taichi uses Python as the frontend, it follows a different set of rules in many aspects, including: -1. [Taichi only supports return statement outside non-static `if`/`for`/`while` scope in the program](#return-statement) +1. [Taichi only supports return statement outside non-static `if`/`for`/`while` scope in the program](#return-statement-and-return-type-annotation) 2. [Variables defined inside an `if`/`for`/`while` block cannot be accessed outside the block.](#variable-scoping) 3. [Taichi does not fully support some language features of Python.](#unsupportedpartially-supported-python-language-features)