Merge pull request #242 from microsoft/learn

Update the wiki to use the right links and offer some better advice about how to debug the wiki

Author: Orta

.github/workflows/sync.yml

@@ -22,7 +22,7 @@ jobs:
       # Update search links from the origin repo before pushing to the upstream
       - run: git clone --depth 1 https://github.com/microsoft/TypeScript.git
       - run: npm i
-      - run: node scripts/convertRelativeLinksToHardcoded.js **/*.md --write
+      - run: node scripts/convertRelativeLinksToHardcoded.js "**/*.md" --write
       - run: rm -rf TypeScript
 
       - run: git add .

README.md

@@ -20,6 +20,16 @@ Then you can open: `http://localhost:4567`
 
 Things to remember:
 
+- Gollum is a bit of a nightmare for testing, my current technique is:
+
+  ```sh
+  # before
+  git branch -b thing_i_am_working_on
+  
+  # to iterate, amend the commit and re-run gollum against that bit of git
+  git add .; git commit --amend --no-edit --no-verify; gollum --ref thing_i_am_working_on
+  ```
+
 - Wikis don't support nesting, so filenames have to get a bit wild
 
   ```diff

compiler/codebase/screenshots/threeslash-refs.png

@@ -17,9 +17,9 @@ This function takes a few params:
 const a = "Hello World";
 ```
 
-  <!-- prettier-ignore-start -->
+<!-- prettier-ignore-start -->
 
 [0]: <src/compiler/checker.ts - function inferTypes(>
 [1]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-6.html#strict-function-types
 
-  <!-- prettier-ignore-end -->
+<!-- prettier-ignore-end -->