earwig / bitshift

A semantic search engine for source code
https://bitshift.benkurtovic.com/
MIT License
30 stars 5 forks source link

Add a developers page for the API. #56

Closed sevko closed 10 years ago

sevko commented 10 years ago

Add a developers page, which will document our API.

sevko commented 10 years ago

@earwig , are you willing to implement this?

Note that it overlaps heavily with #73 ; I think the query language should be documented in /docs, and that /developers should currently retain mostly empty. /developers will basically contain a description of our API, which doesn't have much substance and doesn't need any explanations beyond how queries work.

earwig commented 10 years ago

I can do it, but it won't be too soon.

sevko commented 10 years ago

Alright. I'm nearly finished with #73 , so you'll only have to add a brief description about how hand-written queries work (with the escaped quote weirdness).

earwig commented 10 years ago

I'll look into it after #74 and various misc fixes (text-only searching is broken right now).