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

Near-Term Website Simplications (March 2023) #2728

Closed
9 tasks
DanielRosenwasser opened this issue Feb 28, 2023 · 5 comments
Closed
9 tasks

Near-Term Website Simplications (March 2023) #2728

DanielRosenwasser opened this issue Feb 28, 2023 · 5 comments
Assignees
Labels
documentation Changes only affect the documentation Feature New concepts Playground Plugins Relates to plugins Playground Issues that affect the Playground

Comments

@DanielRosenwasser
Copy link
Member

The primary use-case for the website is to learn how to use TypeScript. We think there are some opportunities to simplify our pages to avoid overwhelming newcomers. Additionally, we have a lot of UI whose surface area translates to testing costs that often need to be repeated.

After discussing among @RyanCavanaugh, @navya9singh, and others, we came to a list of near-term improvements we'd like to make. So in the next month or two, we'd like to make the following simplifications:

  • Remove "Popular Documentation Pages" from the footer
  • Remove duplicate "Get Started" sections on the landing page
  • Remove header link to Handbook (prefer Docs), possible rename to "Documentation"
  • Make Docs a special page within the same docs view that the handbook, references pages, etc. live
  • Investigate whether the build tool integration page can link out to external resources
  • Move Branding page to a GitHub repo
  • Move Cheat Sheets to a docs page or GitHub repo
  • Delist Tools from the header
  • Remove "Errors" view and "Plugins" view from the TypeScript Playground
@DanielRosenwasser DanielRosenwasser added documentation Changes only affect the documentation Playground Issues that affect the Playground Playground Plugins Relates to plugins Feature New concepts labels Feb 28, 2023
@Agapurnis
Copy link

Remove "Errors" view and "Plugins" view from the TypeScript Playground

Does that imply removal of these tabs altogether? Or is it just making the tabs invisible to a newcomer by changing the settings defaults?

@DanielRosenwasser
Copy link
Member Author

I've heard a few people ask about the Errors tab - I think we'd be open to keeping that around.

Plugins though, we're more skeptical of, and we wonder if using something like https://vscode.dev is a better mechanism for these use-cases. Out of curiosity, what are some plugins you currently use @Agapurnis?

@Agapurnis
Copy link

I'd definitely be a fan of keeping the Errors tab around.

Out of curiosity, what are some plugins you currently use @Agapurnis?

I don't seem to often find myself using them. A lot of the plugins seem to have too-niche of a purpose for me, or are tools to make the editor more on-par with a larger IDE. If I ever need the latter, I'll usually end up switching to something like StackBlitz.

@tjjfvi
Copy link
Contributor

tjjfvi commented Mar 10, 2023

I personally find the plugins to be an extremely useful part of the playground, and extensively use the link shortener, vim, and prettier plugins. vscode.dev is a great tool, but (afaik) there's no way to share links with it – especially in the context of the TS Discord, where the playground is the go-to way to share code.

@typescript-bot
Copy link
Collaborator

Hello! As per #2804, we are automatically closing all open issues. Please see #2804 for a description of what issues and PRs can be accepted going forward.

@typescript-bot typescript-bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation Feature New concepts Playground Plugins Relates to plugins Playground Issues that affect the Playground
Projects
None yet
Development

No branches or pull requests

5 participants