https://github.com/clarin-eric/cereal
Central Repository for All documentation
https://github.com/clarin-eric/cereal
Last synced: 5 months ago
JSON representation
Central Repository for All documentation
- Host: GitHub
- URL: https://github.com/clarin-eric/cereal
- Owner: clarin-eric
- License: gpl-3.0
- Created: 2022-04-17T14:27:38.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-11T18:32:32.000Z (6 months ago)
- Last Synced: 2025-12-12T23:13:19.083Z (6 months ago)
- Size: 84 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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