Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Website updates for v10 release #1297

Merged
merged 26 commits into from May 15, 2021
Merged

Website updates for v10 release #1297

merged 26 commits into from May 15, 2021

Conversation

cspotcode
Copy link
Collaborator

@cspotcode cspotcode commented Apr 13, 2021

Goal is to move all documentation into the new website format.

Closes #1296
Closes #1228
Closes #1221

TODOs

  • 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
    • TypeScript Node
    • TS Node
    • ts-node
    • ts-node (in backticks)
  • write Usage page
  • remove "under construction" banner
  • transform links in README.md to point to headers correctly
  • Revisit "Troubleshooting errors" page
  • Revisit "Imports: CommonJS vs native modules"
    • name
      • CommonJS vs native ECMAScript modules
    • add "best of both worlds" explanation to CommonJS: can use modern syntax while preserving compatibility with the majority of node tooling that has not necessarily updated to native ESM
  • Revisit "shebang"
    • move to "advanced?"
    • deduplicate with "usage"
    • explain shebang gotchas
    • consider keeping as discussion thread?
  • add "API" page to "Advanced" section
    • 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.
  • Add "Make it fast" page describing transpileOnly and swc compiler

@codecov
Copy link

codecov bot commented Apr 13, 2021

Codecov Report

Merging #1297 (f91aae5) into main (6084866) will not change coverage.
The diff coverage is n/a.

Impacted Files Coverage Δ
src/index.ts 78.09% <ø> (ø)

@cspotcode cspotcode added this to the 10.0.0 milestone Apr 13, 2021
@cspotcode
Copy link
Collaborator Author

@blakeembrey I updated the website publishing to publish from this branch instead of main. I also have the README on this branch rendering from the website's MD files.

https://typestrong.org/ts-node/
https://github.com/TypeStrong/ts-node/tree/docs#readme

When I'm done with all the TODOs, this will definitely need a review to make sure it's intuitive to people who are not intimately involved with the project. I'm cautiously optimistic that these changes will be well-received, but I'm also wary of changing too much and accidentally making some things confusing.

@cspotcode cspotcode mentioned this pull request May 15, 2021
@cspotcode cspotcode marked this pull request as ready for review May 15, 2021 20:31
@cspotcode cspotcode mentioned this pull request May 15, 2021
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant