Figure out how to expose development documentation

[wichert]

We have various bits of developer documentation:

• How to write a new pattern.
• Various bits of internal API documentation.
• Technical description of exact parser syntax.
• How to run tests.
• How to integrate in applications.

Currently we have no place for these in the website, so they are only kept as text files in the source. It would be nice to have them available via the website as well.

[cornae]

Good point. I like to think of a place for that.

Op 1 feb. 2013, om 16:36 heeft Wichert Akkerman notifications@github.com het volgende geschreven:

We have various bits of developer documentation:

How to write a new pattern.
Various bits of internal API documentation.
Technical description of exact parser syntax.
How to run tests.
How to integrate in applications.
Currently we have no place for these in the website, so they are only kept as text files in the source. It would be nice to have them available via the website as well.

—
Reply to this email directly or view it on GitHub.

[wichert]

Another one: the changelog.

[cornae]

Very important to have that on the website.

Op 1 feb. 2013, om 16:41 heeft Wichert Akkerman notifications@github.com het volgende geschreven:

Another one: the changelog.

—
Reply to this email directly or view it on GitHub.

[wichert]

To start this off patterns already has several documents that target developers:

• the changelog
• parser API
• creating a pattern
• store API

[cornae]

Thanks, that summary is very helpful.

[jcbrand]

We've reorganized the documentation and it's now shown in Patterns-site but exist in Patterns repo.

This is explained in the Patterns-site README.