Developer documentation

[paulswartz]

We recently added better docs for users. We s should also have some getting-started docs for developers:

• links to docs for the libraries we're using
• how the code is organized
• code expectations (tests, organization, &c)?
• style guide?

[paulswartz]

Perhaps this should go in the Wiki instead of the repository?

[paulswartz]

Libraries: Flight, Leaflet, Jasmine (tests)

[alexisylchan]

I added a finda.wiki.git submodule https://github.com/alexisylchan/finda/wiki/Home/c67751ef451b488c99599ef0fd9654e5bf27f2cd

but it's not showing up in https://github.com/alexisylchan/finda/wiki

[paulswartz]

I you don't need to add finda.wiki as a submodule; it's a separate repository. Have you also committed/pushed your changes in the wiki repository?

[paulswartz]

Oh, I see; you checked them into a different branch, but the Wiki only works off of the master branch.

[paulswartz]

You can edit the pages directly, as well: https://github.com/codeforboston/finda/wiki/Home/_edit

[alexisylchan]

Thanks - I created a master branch and now the images are linked correctly here https://github.com/alexisylchan/finda/blob/master/finda.wiki/Home.md but not in the wiki https://github.com/alexisylchan/finda/wiki

[paulswartz]

Seems like you may need to update the image URLs: http://stackoverflow.com/questions/10045517/embedding-images-inside-a-github-wiki-gollum-repository#answer-14931420

[alexisylchan]

Apparently I just missed adding wiki/ to the relative path. Thanks.

[paulswartz]

Thanks to @alexisylchan there's now content on the Wiki! There's user documentation at Getting Started and some initial developer docs at Developing Finda and Development Resources.