Update documentation

[NickSto]

We need to update the documentation for the whole project. I think the README.md is already out of date in some places and omits a lot. And the CONTRIBUTING.md hasn't been updated since the switch to Gridsome. Both documents are basically the same topic, so they should be merged into one or split into topic-specific documents.

Metadata description

One thing we need is a description of all the possible metadata keys you can put in the yaml header of a Markdown file.

There's actually already a listing of just about every valid key in the files in content/0examples. The purpose of those files is both to serve as documentation and as dummy files that populate every field. Otherwise, if there's a query anywhere for a field that doesn't exist in any current page, the site will fail to build. We can also avoid this by explicitly defining those fields with addSchemaTypes() in gridsome.server.js.

It might be possible to keep this all in one place: maybe config.json or some other static file which holds the list of metadata keys and their descriptions. Then that file could be used in gridsome.server.js to populate the addSchemaTypes() call, as well as to generate a documentation page. I'm pretty sure we could create the page object in gridsome.server.js. Or at the very least we could make a special .vue dynamic page file.

[FrozenGirl-spd]

Hi @NickSto , I'd like to work on the issue. May I ?

[NickSto]

Hi @NickSto , I'd like to work on the issue. May I ?

Sure, you're more than welcome to. But I'd caution that this might not be the easiest issue to start with. By definition it's about writing documentation for things that currently have no documentation. A lot of the things that need to be explained probably only really exist in my head.

That said, if you can find some things that are clear enough and just aren't written down yet, it'd certainly be helpful.