Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 972 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (8 loc) · 972 Bytes

Contributing to the docs site

Thanks for helping out! Just a couple things to know about how this site is put together:

  • Docs in the /docs page are pulled in by a script from each module. If you're reporting a documentation issue, please do so in the individual module's README.md rather than here. This helps us keep docs closer to code and since it pulls from last published npm, docs will be up-to-date with what you install from there.

  • The guides at /learn/* are built from the markdown files in the learn_markdown directory, so make edits there.

  • Other stuff is built from jade files in various folders.

  • Hop into the chat room on gitter if you have questions, or just to hang out and talk about Ampersand.js

  • Don't worry about re-building anything, just send pull requests with edited markdown files, we'll rebuild when we merge and publish, thanks!

Thanks again for making the docs better <3!