SDK documentation
Closed this issue · 2 comments
I'm closing #12 as a technical duplicate, but the point still stands..
Now, we need to keep the documentation in one, consistent place. That would either be the Wiki, or GH-Pages. I was slightly leaning towards the wiki, as anybody could edit it quickly, but the description references the GH-Pages URI, which would eventually be going to PyPI. Of course, we could end up just referencing the wiki in the GH-Pages..... Ack, so many choices!
The big thing is we need to explain the layout of the SDK, but not delve too much into how FamilySearch itself works (which is already explained on FamilySearch's developer page), but we can definitely link to it.
Nonetheless, other than some "minor" details I need to take care of on my end, I think this is the only thing that I need to take care before publishing to PyPI.
Personally, I think that having the links to the FS documentation in the docstring is probably the best thing to do, especially if we use something like readthedocs. That way, the GH-Pages wouldn't need to be updated too often...
I think it's done enough to publish, and I've got all potential publishing snags out of the way!
Time to PUBLISH!