Add meta description to docs #2316

StephanHoyer · 2018-11-27T22:53:13Z

rework of #2149

Description

added a meta description parser and meta descriptions to all docs pages

Motivation and Context

because google

How Has This Been Tested?

built the docs, inspected the output manually

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation change

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.
I have updated docs/change-log.md

StephanHoyer · 2018-11-27T22:53:28Z

closes #2149

StephanHoyer · 2018-11-27T22:56:21Z

I mostly copied over the descriptions from @kylebackerio but I'm not 100% happy with them. Maybe I'll go over them tomorrow again.

Feel free to add some comments though

dead-claudia

Found a couple small nits, but there's a few common themes with the rest of my suggestions:

I'd like the descriptions to remain consistent.
Meta descriptions are supposed to be describing the site or page, not necessarily the content itself. Of course there's a lot of overlap, but there is a subtle difference.
Some of your descriptions are a bit wordy.
Some of your descriptions are not quite accurate (missing details, incorrect details, etc.).

Apologies for the massive number of suggestions here.

docs/examples.md

docs/fragment.md

docs/index.md

docs/installation.md

docs/buildQueryString.md

docs/request.md

docs/stream.md

docs/trust.md

docs/vnodes.md

docs/withAttr.md

docs/support.md

docs/components.md

docs/css.md

docs/es6.md

docs/examples.md

docs/fragment.md

docs/framework-comparison.md

docs/hyperscript.md

docs/installation.md

docs/jsonp.md

docs/jsx.md

docs/keys.md

docs/mount.md

docs/parseQueryString.md

docs/promise.md

docs/prop.md

docs/releasing.md

docs/render.md

docs/request.md

docs/route.md

docs/signatures.md

docs/simple-application.md

docs/stream.md

docs/testing.md

docs/vnodes.md

docs/withAttr.md

StephanHoyer · 2019-01-22T13:09:01Z

@isiahmeadows I included all you suggestions and also fixed punctuation (hopefully). Also squashed all in on commit and rebased on next

dead-claudia

LGTM mod a few nits and the missing <meta> description.

docs/generate.js

docs/releasing.md

docs/support.md

docs/version.md

docs/api.md

docs/change-log.md

docs/code-of-conduct.md

docs/components.md

docs/contributing.md

docs/mount.md

docs/releasing.md

docs/signatures.md

docs/support.md

docs/version.md

docs/buildQueryString.md

docs/framework-comparison.md

docs/index.md

docs/mount.md

docs/releasing.md

docs/simple-application.md

tbreuss

Found some docs issues, nothing serious.

docs/framework-comparison.md

docs/index.md

docs/lifecycle-methods.md

docs/mount.md

docs/simple-application.md

StephanHoyer mentioned this pull request Nov 27, 2018

Meta description snippets for documentation pages #2149

Closed

11 tasks

dead-claudia requested changes Nov 28, 2018

View reviewed changes