osmlab / to-fix-backend

The to-fix server
BSD 3-Clause "New" or "Revised" License
15 stars 13 forks source link

Postgis docs #117

Closed mcwhittemore closed 7 years ago

mcwhittemore commented 7 years ago

@batpad and @kepta - here is a quick stab at using jsdocs to stub out our endpoint docs.

We'd then have a pre-commit hook that work run documentation build lib/server.js -o ./docs so that a docs folder would be updated every time we commit.

This PR hasn't added documentation.js to the project or the docs folder.

Here are the cli docs for documentation.js

kepta commented 7 years ago

@mcwhittemore @batpad Note: the @name tag doesn't take special characters due to a bug upstream. ref.

I have tried to add documentation to all the endpoints, might need some correction though.

mcwhittemore commented 7 years ago

@kepta what do you think about using documentation readme vs documentation build? It looks like this will drop the Table of Contents and will let the API.md file have more in it than just these docs.

batpad commented 7 years ago

@kepta I'm a bit unfamiliar with the details and was unable to give a thorough review, but if you've taken @mcwhittemore's suggestions into account, let's resolve conflicts and merge this! Can make further changes as required in a separate PR.

kepta commented 7 years ago

Going ahead and merging this.

@mcwhittemore I have incorporated the changes you have requested, please feel free to point something that I missed.