search

commercetools / commercetools-ios-sdk

The e-commerce iOS SDK from commercetools.
https://docs.commercetools.com/sdk/swift-sdk
Other
21 stars 10 forks source link

Define our Documentation strategy #21

Closed cneijenhuis closed 7 years ago

cneijenhuis commented 8 years ago

What do we want to document and where? We definitely want to fill the README.md with some info on getting started. Where should additional reference info go? Should we use something like CocoaDocs or stick to .md files? Can we use our tests as examples?

nikola-mladenovic commented 8 years ago

We should definitely use CocoaDocs, but also we can use jazzy - it hooks into Clang and SourceKit to use the AST representation of our code and its comments;

It generates Apple like documentation pages, and we can have the output html available on our ghpages.

cneijenhuis commented 8 years ago

I've used neither and am fine with both :)

Can one of the two embed our test cases into the documentation? E.g. like here in the JVM SDK: https://github.com/sphereio/sphere-jvm-sdk/blob/67ed19ea22d2c1c6883bc57ca1124cade287cbc8/commercetools-internal-docs/src/main/java/io/sphere/sdk/meta/GettingStarted.java#L40