Dear KBase Module Owner,

Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is:

If the module's Makefile conforms to the KBase standard Makefile, “make deploy” will have run “make deploy-docs”, which should make the html documents and copy them to webroot: ($(TARGET)/services/$(SERVICE)/webroot/ where $(TARGET) is typically /kb/deployment and $(SERVICE) is the name of your service--so, for example, /kb/deployment/services/idserver/webroot). These docs are normally generated from the comments in the typespec. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME.

RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013)

MODULE NAME: registry

AUTHOR(S): Tom

DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/registry

API DOCS PRESENT AT THAT URL? No--directory does not exist, though Makefile does have deploy-docs target.

API DOCS OK? No. No API docs at URL. Typespec seems to be reasonably well-commented, though lacking a top-level description.