A Place for Docs

[bradfrost]

It would be nice to have an area for documentation about the code of the site. While annotations are fantastic for documenting the patterns themselves, there are other areas that need documented (CSS/Sass strategy, JS architecture, overall design principles, etc). While these could (should?) be covered in separate documents, it's worth considering making a place in Pattern Lab for these types of documents to live.

Making this happen will require a lot of thought, since these aren't actual interface patterns. Perhaps it could be rolled into the "view" dropdown?

There would also need to be some thought put into format (markdown, etc), support for images or whatever, and so on.

Putting this on here to plant the seed.

[dmolsen]

This is a really good idea. What might be easier rather than writing in markdown would be to provide a list of files. We could just spit out an unordered listing of files. That way someone could have mock-ups or Word docs or whatever and still store them without converting. So we could have a source/_docs dir that is Markdown that gets converted as well as source/_files that are a list of files that get rendered into that unordered list.

[bradfrost]

I really like the files idea. Because yeah some teams will be working in Word, or PDFs, or Markdown, or whatever.

[benedfit]

My Boss would up vote this issue