Skip to content

Website updates for v10 release - #1297

Merged
cspotcode merged 26 commits into
mainfrom
docs
May 15, 2021
Merged

Website updates for v10 release#1297
cspotcode merged 26 commits into
mainfrom
docs

Conversation

@cspotcode

@cspotcodecspotcode commented Apr 13, 2021

Copy link
Copy Markdown
Collaborator

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

codecovBot commented Apr 13, 2021

Copy link
Copy Markdown

Codecov Report

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

Impacted FilesCoverage Δ
src/index.ts78.09% <ø> (ø)

@cspotcodecspotcode added this to the 10.0.0 milestone Apr 13, 2021
@cspotcode

Copy link
Copy Markdown
CollaboratorAuthor

@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.

@cspotcodecspotcode mentioned this pull request May 15, 2021
@cspotcode
cspotcode marked this pull request as ready for review May 15, 2021 20:31
@cspotcodecspotcode mentioned this pull request May 15, 2021
17 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@cspotcode