feedhenry / fh-sync

Node.js implementation of the FeedHenry Data Synchronisation Server. To be used in conjunction with the FeedHenry Data Synchronisation Client.
http://feedhenry.org
Apache License 2.0
5 stars 17 forks source link

Upstream documentation migration #7

Closed wtrocki closed 7 years ago

wtrocki commented 7 years ago

Issue #4

wtrocki commented 7 years ago

@david-martin - Reviewed documentation and removed lots of typos. Api documentation commit is optional - I think we should not commit it as it may be just generated on separate github pages branch :)

wtrocki commented 7 years ago

@david-martin Can we merge that?

david-martin commented 7 years ago

@wtrocki I'd hold off on it until we figure out an upstream/downstream docs plan. If we merged this, my concern is it would get out of date with the docs in the internal gitlab repo with CP docs

wtrocki commented 7 years ago

@david-martin We figured out plan to hold all on feedhenry.org. Until this will be available it's best to hold ascidocs directly in the repos so they can be maintained.

@secondsun Do you think we can merge this to this repo? We want to update documentation in some temporary place until actual documentaion on feedhenry.org will be available. We need to add some general improvements to documentation etc.

ping @damienomurchu @emilioicai

damienomurchu commented 7 years ago

@wtrocki +1 for a temporary home for all sync docs we will be looking to host on feedhenry.org eventually

secondsun commented 7 years ago

@wtrocki I think that hosting the docs for projects with the projects makes sense in the short term. There are longer term things to figure out, but that is for the future.

wtrocki commented 7 years ago

Thank you so much lads! Going to improve documentation in separate PR's