cereal

CLARIN's cEntral Repository for in-AppLication documentation

Guidelines and recommendations

General guidelines

• Default choice of markup language should be Markdown
• The application must cache the documentation content with a reasonable periodic refresh at run-time
• A failed refresh of the cache should not invalidate the existing cached copy (i.e. first priority should be availability of the documentation)
• The cache should be preloaded with a copy of the documentation that is included at build time (again prioritizing on availability of the documentation even in case of unavailability of the live source)

Technology specific

TODO