search

foursquare / fsqio

A monorepo that holds all of Foursquare's opensource projects
Apache License 2.0
252 stars 54 forks source link

Start populating the github wiki #32

Closed mateor closed 7 years ago

mateor commented 7 years ago

We have some internal documentation that I can migrate to the wiki - and we have had multiple consumers write up their experiences consuming plugins.

I think my favorite answer is to just add .md files in the source. I know it is a little non-standard but the contributor list is so small that I don't have much faith in being able to keep a separate wiki from drifting.

The short term answer is to take the text of issues #27,#28, #29, #30 and somehow surfacing them on the Fsq.io wiki tab.

mateor commented 7 years ago

The new model is to add .md pages at target level. We accept pull requests for documentation, with the preference being to place the docs as close to the code as possible.

So that means that we are not planning on integrating the Github wiki, at least not as a separate entity.