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

docs: Proposed link updates for TS learning paths #2827

Closed
wants to merge 1 commit into from

Conversation

mehicalen
Copy link

@mehicalen mehicalen commented May 14, 2023

While reading the TypeScript documentation, I went from The TypeScript Handbook intro page to TypeScript for JavaScript Programmers page which then leads me back intro page in the "Next Steps" section. This PR proposes a change to direct users directly to first section of the handbook instead of the intro page.

@mehicalen
Copy link
Author

@microsoft-github-policy-service agree

@@ -593,5 +593,5 @@ consistently used in TypeScript code.

This doc is a high level overview of the syntax and types you would use in everyday code. From here you should:

- Read the full Handbook [from start to finish](/docs/handbook/intro.html)
- Read the full Handbook [from start to finish](/docs/handbook/2/basic-types.html)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that if anything, we should explicitly state that this is going to skip ahead in the handbook, like the intro page itself. Something like:

Get started with The Basics

Which is the beginning of the final section of the intro.

@jakebailey
Copy link
Member

On a second look, I'm not sure that it's a good idea to link to the specific page anyhow; it may be the case that the first page changes, or is moved. Or, the user may go back to the main page and read a different guide.

@jakebailey jakebailey closed this Jul 24, 2023
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.

2 participants