Strip down readme and update website

[jaredpalmer]

Current Behavior

I forgot to strip down the readme when doing the site. It's confusing to have docs on both the readme and website as there is no single source of truth.

Expected behavior

The website is the source of truth for documentation.

Suggested solution(s)

Strip down readme to logo, one-liner description, badges, links to website, plus contributors. Update website to remove any discrepancies w/ current readme.

[agilgur5]

This issue is a response to #844 (comment) and a result of #765

I agree it's confusing if they're different (they are slightly right now), but if they're the same then 🤷 Could do the same thing as the Releases/Changelog page and just pull the README into the website.

I'm not sure I agree with the suggested solution. It's always annoying when you're on GitHub and you find some interesting repo but there's little to nothing in the README and it just points to a separate website. It requires another click which is generally not good UX (there's drop-off/that requires another conversion) and isn't great for SEO either. We also get more contributors to docs that are easy to edit like the README (not so with template docs as a counter-example)

[agilgur5]

Per my last email, I'd also appreciate if the Vercel bot were turned off as it's giving me a massive amount of unnecessary notifications instead of using GitHub status checks and only running on website PRs/commits like Netlify did.

[jaredpalmer]

Gonna have to disagree with you about docs. As someone that has dealt with this before, Google figures out rather quickly when documentation is moved over.

The readme should look like this:

[agilgur5]

The readme should look like this:

I'm aware of what these look like, I'm just not really a fan of these; it's a page that just links elsewhere. It doesn't tell me why I should use the library/repo.

As someone that has dealt with this before, Google figures out rather quickly when documentation is moved over.

That's not what I said -- I'm saying that it de-prioritizes the actual repo since the content is elsewhere. Things like this can also happen:

here's mobx-state-tree's results:

vs. Jest's results:

Jest is a good example too because it still has a README. And each package has its own README that is not on the website too. I have well-documented plans to make TSDX itself into a monorepo to handle things like Presets (#634 ) and Shareable Plugins (#635 ), among other things. So these add questions of how that should be handled with a website (with READMEs, it's pretty straightforward).

[jaredpalmer]

Go for it then. Either way the website should be updated or symlinked such that contributors know where to make edits.