-
-
Notifications
You must be signed in to change notification settings - Fork 543
Description
Docs aren't fun, so I'm creating an epic to track all docs tasks in one place.
Some of these items came from the TODO list on #1297. I'd spent too long on #1297, so I wanted to merge it as-is and tackle these items in the future.
-
Refer to CommonJS / ESM consistently across all docs; link to common page explaining the difference
- CommonJS
- Native ECMAScript modules
- ESM
- native ESM
-
Refer to ts-node consistently; naming is inconsistent throughout the readme (implemented in changed all references to ts-node consistent #1481)
- TypeScript Node
- TS Node
- ts-node
ts-node
(in backticks)
-
remove "under construction" banner
-
Additions to "Troubleshooting" page
- Add common ESM errors to Troubleshooting page #1607
- Common troubleshooting tricks?
-
Revisit "shebang" (implemented by Docs overhaul #1682)
- move to "advanced?"
- deduplicate with "usage"
- explain shebang gotchas
- consider keeping as discussion thread?
-
add "API" page to "Advanced" section (implemented by Docs overhaul #1682)
- list cool things you can do with the API
- create a custom REPL
- simpler TS compiler wrapper
- detect if ts-node is already installed via
process.
- list cool things you can do with the API
-
Update "Ignored files" > "File extensions" to include mjs, mts, cts, cjs #1899
-
ignore
option docs unclear; should point out they're regexps #1089 -
Tweak options docs to give each a header; draw inspiration from typedoc #1606
-
Add json schema-powered shiki twoslash tooltips to docsite #1675