Skip to content

Documentation updates #785

@ark120202

Description

@ark120202

The first thing I suggest is moving documentation from GitHub Wiki to the website:

  • It's properly versioned
  • It's easier to modify it for contributors
  • It can be edited locally, with a proper code editor
  • It would have more user-friendly interface
  • We would be able to add some interactive features, like embedding playground to docs (see 💌📯 Updates microsoft/TypeScript-Website#130 for more examples)

One thing that has to be decided is a static site generator we're going to use. I've checked out most of popular JS generator, and I think the best ones we can choose would be either Gatsby or Docusaurus. Docusaurus supports more things out of the box, but Gatsby has a rich plugin system, making it easier to customize.

Another thing I propose is moving website/documentation to this repo. That's a more controversial change (though that's a quite common practice), and it has it's tradeoffs, but there are a bunch of advantages as well:

  • It makes it even more easier to modify it, because adding a feature and documenting it can be done in one PR
  • It's much easier to do playground deployment previews for PRs, which is very useful for previewing changes without local checkout (we would be able to do it like Prettier does, otherwise we'll have to write a bot to do that)
  • It has full access to raw code, so it would be easier to generate API documentation from JSDoc

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions