Documentation in this repo covers the development, operation, and design of the Sample Service. It may contain some information about other KBase or 3rd party systems as they relate to the Sample Service.
It does not cover:
- user documentation
- whole system
All documentation is contained in the following locations:
- the
/docsdirectory contains the bulk of documentation and diagrams - the
README.mddocument contains brief information about this repo and a pointer to documents - the
RELEASE_NOTES.mddocument follows ____ and should note all notable changes to this repo - the
LICENSEfile contains the standard KBase license in plain text format
All text other than the license is written in markdown, specifically GitHub Flavored Markdown.
It is recommended to edit documentation with a markdown editor which provides syntax highlighting and live preview. This may be an external editor, such as Mark Text, or a coding IDE which provides such support, such as Visual Studio Code or PyCharm.
[ TO DO ]
[ TO DO ]