Title: Website Roadmap · Issue #94 · microsoft/TypeScript-Website · GitHub
Open Graph Title: Website Roadmap · Issue #94 · microsoft/TypeScript-Website
X Title: Website Roadmap · Issue #94 · microsoft/TypeScript-Website
Description: If you'd like to see and know more about the website infrastructure, there is an "updates thread" which digs into both what has been happening, and why. My roadmap for the site + branding, influenced strongly by community feedback in mic...
Open Graph Description: If you'd like to see and know more about the website infrastructure, there is an "updates thread" which digs into both what has been happening, and why. My roadmap for the site + branding, influenc...
X Description: If you'd like to see and know more about the website infrastructure, there is an "updates thread" which digs into both what has been happening, and why. My roadmap for the site + bran...
Opengraph URL: https://github.com/microsoft/TypeScript-Website/issues/94
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Website Roadmap ","articleBody":"If you'd like to see and know more about the website infrastructure, there is [an \"updates thread\"](https://github.com/microsoft/TypeScript-Website/issues/130) which digs into both what has been happening, and why.\r\n\r\nMy roadmap for the site + branding, influenced strongly by community feedback in https://github.com/microsoft/TypeScript/issues/31983. Presented, roughly, as a linear priority list but in reality quite a lot are interlinked and so are being worked on concurrently. \r\n\r\n- [x] New Index Page \r\n- [x] Replacement for intermediary pages (samples etc)\r\n- [x] New Handbook Design\r\n- [x] New Playground v3\r\n- [x] Dark Mode\r\n- [x] TSConfig Reference\r\n- [x] Internationalization ([roughly](https://github.com/microsoft/TypeScript-Website/issues/100))\r\n- [x] Branding Page\r\n- [x] Search\r\n- [x] Mobile nav\r\n- [x] a11y audit\r\n\r\n\r\n### New Logo\r\n\r\n[Embrace the community logo](https://github.com/remojansen/logo.ts) by creating an official logo influenced by that version with some minor design tweaks.\r\n\r\n\r\n[Figma](https://www.figma.com/file/hCZSxoL1rbJxX3Ua3kGNKB/ts-design-spec?node-id=0%3A1)\r\n\r\nThis logo is then used throughout the re-designs below, and important for the branding page. We can provide official resources then ( see branding page at the bottom )\r\n\r\n### ~~Re-designed Docs pages~~\r\n\r\n\r\n[Figma](https://www.figma.com/file/x8FJrNqj6oupqWn1s3uMg4/Website?node-id=7%3A0)\r\n\r\n- Brings it more in line with docs.microsoft.com \r\n- [Utilise the TypeScript compiler for error messaging and introspection](https://github.com/microsoft/TypeScript-Website/issues/120)\r\n- Improve the navigation both in-page and for sections like the handbook\r\n- Support switching code samples into playground sandboxes\r\n- Design offers some useful extras:\r\n - Shows contributors to the page, which should provide some incentive for more authors\r\n - Shows when it was last updated\r\n\r\n### Redesigned Index page\r\n\r\n\r\n[Figma](https://www.figma.com/file/x8FJrNqj6oupqWn1s3uMg4/Website?node-id=4%3A54)\r\n\r\nAimed at:\r\n\r\n- simplifying TypeScript's messaging, making it easier for non-technical people to grok\r\n- emphasize scope of DTS and how TS powers a lot of editor support for JS \r\n- provide mode jump off points to docs, and understanding of TS release schedules\r\n- showcasing work in TC39\r\n- updating testamonials\r\n- highlighting more talks from TS core team\r\n- Have a design aesthetic which is closer to Microsoft's fluid UI system\r\n- de-empathise the spec, given it's lack of updates\r\n\r\n### ~~Add search to the site~~ 🎉 Done\r\n\r\nSuper highly requested, algolia have reached out and will [provide DocSearch](https://community.algolia.com/docsearch/) for free over existing TS site as they do for other large OSS JS sites. I've worked with them before and it's been 👍 \r\n\r\n\r\n\r\n### Fix some DNS issues\r\n\r\n- You _have_ to use `www.` today, that's a shame\r\n- `http` links should be redirect to `https` to stop people thinking we've mis-configured the site\r\n- Maybe a smaller link for playground URLs?\r\n\r\n### ~~TSConfig Tooling~~\r\n\r\n\r\n\r\n- Build a page which consolidates all docs on the TSConfig, maybe a playground-like experience as well as a full linkable reference. [tsconfig-ui](https://github.com/MatterhornDev/tsconfig-ui) might be a good place for exploration there. See https://github.com/microsoft/TypeScript-Website/pull/103 for WIP\r\n- Have sample TSConfigs for particular type of libraries\r\n- Provide more extensive documentation about each flag inside the compiler, this can come from [the new handbook too](https://github.com/microsoft/TypeScript-New-Handbook/blob/master/reference/Compiler%20Options.md)\r\n\r\n### I18n\r\n\r\nAdd support for non-English documentation https://github.com/microsoft/TypeScript-Website/issues/100\r\n\r\n\r\n### CLI Docs\r\n- Re-examine `tsc --help` because:\r\n - Not all compiler flags are in there\r\n - It should probably link to this resource\r\n\r\n### Community Section\r\n\r\n#5 has a lot of context for this\r\n\r\n- Encourage more people connect offline\r\n- Provide \"blessing\" for resources to have a more consistent way to have the community help each other\r\n- Give ownership of sections to people who want to do work in the community\r\n- Highlight books, mailing lists etc which lets people learn in alternative ways\r\n\r\n### ~~Dark Mode for docs + playground~~\r\n\r\nI'm getting daily pings about this, in part because it's become a meme but I think all popular consumer OS' now support light/dark modes and there's https://github.com/microsoft/TypeScript-Website/issues/90\r\n\r\nLikely to come in with the redesigned pages.\r\n\r\n### ~~Allow community localizations~~\r\n\r\nTwo big OSS JS sites have been doing community translations of content (react and Gatsby) and we can reuse their infra and ideas - https://github.com/gatsbyjs/rfcs/pull/42\r\n\r\nWe can use tools like [code-organizer-merge-on-green](https://github.com/orta/code-organizer-merge-on-green) to allow others to handle merging PRs to languages they know\r\n\r\n### Convert from \"everything in the handbook\" to site sub-sections\r\n\r\n\r\n[Figma](https://www.figma.com/file/Sew0DK1pRVPVXF6aAarfQHjk/Sitemap?node-id=0%3A1)\r\n\r\nToday almost all information about TypeScript lives in the handbook, ideally that would only be the language reference. We can kill the submodule and migrate it into the site (now that the site is OSS).\r\n\r\nWith sub-sections things like:\r\n\r\n - Using JSDoc for Types\r\n - Migrating from JS to TS\r\n - Migrating from TS to TS Strict\r\n - Working with Definitely Typed\r\n - Using Projects to split up big repos\r\n - Using TypeScript with build tools\r\n - Shipping a JS Library with types\r\n - React + TypeScript (it's one of the biggest TS eco-systems where they have little to official docs on how they work together)\r\n\r\nWe can also give ownership of some of these areas to contributors using [code-organizer-merge-on-green](https://github.com/orta/code-organizer-merge-on-green)\r\n\r\n### Better Resources for Compiler API users\r\n\r\n- Audit existing documentation in the wiki\r\n- Add JSDoc comments to anything missing them in the public interface\r\n- Provide a full API reference via [api-extractor](https://api-extractor.com) https://github.com/microsoft/TypeScript-Website/issues/80\r\n- Maybe move resources into a sub-section on the site\r\n\r\n### Explore an interactive guide to basic + advanced types\r\n\r\nThe two pages [Basic Types](https://www.typescriptlang.org/docs/handbook/basic-types.html) and [Advanced Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html) represent a quarter of all traffic. Can we make something that consolidates the two, but isn't so dense?\r\n\r\n### Work to ensure multiple explanations of TypeScript concepts\r\n\r\nWe often describe concepts in terms of each other, and sometimes very technically, which can be tough for some learners. \r\n\r\n- Provide playground example alternatives to intermediate and advanced type ideas\r\n- Provide a glossary of TypeScript terms\r\n\r\n### Re-designed Playground\r\n\r\nI added a lot of the features from the re-design in the current v2 of the playground, so it's mostly a design change now. But the revised sidebar would be nice. There's also [~20 open issues on the playground](https://github.com/microsoft/TypeScript-Website/issues?q=is%3Aissue+is%3Aopen+label%3APlayground) this would be a good time to hit some of those.\r\n\r\n\r\n[Figma](https://www.figma.com/file/Q0872II3wi1EzCXV9eUNBqb7/Playground?node-id=5%3A10)\r\n\r\n### ~~Split Playground into Playground + Sandbox~~\r\n\r\n> The TypeScript Sandbox is the editor part of the TypeScript Playground. It's effectively an opinionated fork of monaco-typescript with extra extension points so that projects like the TypeScript Playground can exist.\r\n\r\n[WIP build](https://github.com/microsoft/TypeScript-Website/tree/v2/packages/sandbox)\r\n\r\nThis would allow us to embed the monaco-editor with a lot of playground features into documentation pages on request, as well as allowing external parties to have their own TypeScript powered API references with DTS files trivially.\r\n\r\nRepresents the end of the [typescript-play](https://github.com/orta/typescript-play) fork.\r\n\r\n### New Branding Page\r\n\r\n- [Similar to Discord's](https://discordapp.com/branding) in theme, provides all the logos and some light recommendations on how to use the logo.\r\n\r\n- [Gatsby's](https://www.gatsbyjs.org/guidelines/logo/) is good also \r\n\r\n- Can provide recommendations for how folks can make and print their own stickers\r\n\r\n","author":{"url":"https://github.com/orta","@type":"Person","name":"orta"},"datePublished":"2019-10-23T15:41:44Z","url":"https://github.com/microsoft/TypeScript-Website/issues/94"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:a02d3881-8233-5456-7b0a-38c035fb3425 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A342:31D532:85382E:B07758:6B01AFF4 |
| html-safe-nonce | 20fd87c9fa2fa39ef6eff33b163829c3846a56fef2246591a3f3c81b96176de4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMzQyOjMxRDUzMjo4NTM4MkU6QjA3NzU4OjZCMDFBRkY0IiwidmlzaXRvcl9pZCI6IjUzMjQxMDAxMjI1ODAyMDE0NjAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | f3a74eda89aa413c94c582d8eea5c30283db41337b3dbfa48271a6a3823babe8 |
| hovercard-subject-tag | issue:511413056 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript-Website/94/issue_layout |
| twitter:image | https://opengraph.githubassets.com/6cc7b7416410b23d35955af496d6fd0798472c2f2e0d4a4c3c87c2b38b41304f/microsoft/TypeScript-Website/issues/94 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/6cc7b7416410b23d35955af496d6fd0798472c2f2e0d4a4c3c87c2b38b41304f/microsoft/TypeScript-Website/issues/94 |
| og:image:alt | If you'd like to see and know more about the website infrastructure, there is an "updates thread" which digs into both what has been happening, and why. My roadmap for the site + branding, influenc... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | orta |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript-Website git https://github.com/microsoft/TypeScript-Website.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 193992134 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript-Website |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 193992134 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript-Website |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width