Cwik (pronounced ‘quick’) is an editable documentation web site (wiki) that is quite different from what has been done before:
Here are some examples:
The Gamma function satisfying Γ(n)=(n−1)!∀n∈N is via the Euler integral
Your changes accumulate in local storage on the server. Press the “commit” button (upper right) to commit all edits.
Look here: https://github.com/bitcoin-unlimited/BUwiki to see the backing repository.
To be implemented
This system is able to integrate multiple Git-hosted repositories. A typical configuration would be one documentation focused repository and multiple source repositories. These source repositories can provide inline documentation that is extracted via various documentation generators (subsequently called “codedoc”) and provide access to “raw” source code.
Linking between documentation and code/codedoc or codedoc to codedoc occurs via a special syntax that allows references to code blocks, is tolerant of some code reorganizations, and identifies and records broken links for human repair.
There is a processing step to convert these links to .md format. So the full source data preparation steps are: