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

Docusaurus-powered documentation website #1207

Merged
merged 23 commits into from Feb 10, 2021
Merged

Docusaurus-powered documentation website #1207

merged 23 commits into from Feb 10, 2021

Conversation

cspotcode
Copy link
Collaborator

@cspotcode cspotcode commented Feb 1, 2021

https://typestrong.org/ts-node

Implements #1099

See also: TypeStrong/discussions#6

What if we merge this now so that the website gets published automatically, then iteratively improve the docs over time?

In other words, the website will be live but incomplete, and we won't link to it until it's ready.

@codecov
Copy link

codecov bot commented Feb 1, 2021

Codecov Report

Merging #1207 (69f041e) into master (237ea5a) will decrease coverage by 0.25%.
The diff coverage is n/a.

Impacted Files Coverage Δ
src/index.ts 78.81% <ø> (-0.50%) ⬇️

@cspotcode cspotcode changed the title Docusaurus-powered documentation website Docusaurus-powered documentation website infra Feb 1, 2021
@cspotcode cspotcode changed the title Docusaurus-powered documentation website infra Docusaurus-powered documentation website Feb 1, 2021
@cspotcode
Copy link
Collaborator Author

The sidebar navigation, table of contents, and "prettiness" of the site may encourage people to read the documentation, more easily find the answers they need. Plus I think it frees us up to create dedicated pages with tsconfig samples, examples, stuff like that.

But for npm we still want to have a README. So maybe there's some easy, hacky way to build up the README from the various docs pages, essentially copy-pasting them together via a build script. Then we can write docs for the docsite and still get a meaningful README published to npm.

@cspotcode cspotcode marked this pull request as ready for review February 2, 2021 19:35
@cspotcode
Copy link
Collaborator Author

Added typedoc API docs since it was so easy to do. May prove helpful to link people to an HTML rendition of our programmatic options.

Added a "under construction" message to the first page.

Marked as "ready for review" because I think this can safely be merged today, then we can improve the pages over time until we deem the site ready to recommend to new users.

@cspotcode cspotcode merged commit b3b8573 into master Feb 10, 2021
@cspotcode
Copy link
Collaborator Author

Merged to master, and I'll track future website & docs work in follow-up issues and PRs.

@cspotcode cspotcode added this to the 10.0.0 milestone May 15, 2021
@cspotcode cspotcode deleted the ab/docsite branch October 11, 2021 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant