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.

Sign up for GitHub

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

Jump to bottom

Delete readme content that overlaps with website content #226

Closed

jasonkuhrt opened this issue Jan 6, 2020 · 1 comment

Assignees

Labels

type/meta

Member

jasonkuhrt commented Jan 6, 2020 •

edited

Loading

What

Once Website #210 progresses there will be content overlap between the current README and website.
Delete such content in the README

Why

We do not want to maintain two sets of content.
We do not want to complexify our current build system to automate the above.
We do not want users being conflicted about which content to read.
We do not want to invest twice into good content layout (yes, this is a consideration even in README markdown)

How

Make sure there is a clear link to the website from the README. It should be practically impossible to read the README and not notice that there is a website to navigate to.
Add to repo URL

Related

Website #210

jasonkuhrt added blocked type/meta and removed blocked labels

This comment has been minimized.

Sign in to view

jasonkuhrt self-assigned this

jasonkuhrt closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment