diff --git a/docs/_clef/Overview.md b/docs/_clef/Overview.md index b39a026306..f4a72b5ef6 100644 --- a/docs/_clef/Overview.md +++ b/docs/_clef/Overview.md @@ -3,8 +3,6 @@ title: Clef overview --- -Clef -=== _A reasonably secure wallet_ Goal: Accommodate arbitrary high requirements for security (through _isolation_ and _separation_), while still providing _usability_. diff --git a/docs/_clef/Rules.md b/docs/_clef/Rules.md index 32dc3fe9db..ef25159434 100644 --- a/docs/_clef/Rules.md +++ b/docs/_clef/Rules.md @@ -2,8 +2,6 @@ title: Rules --- -# Rules - The `signer` binary contains a ruleset engine, implemented with [OttoVM](https://github.com/robertkrimen/otto) It enables usecases like the following: diff --git a/docs/_clef/Setup.md b/docs/_clef/Setup.md index 6af7fb0dc7..8eaa60b23c 100644 --- a/docs/_clef/Setup.md +++ b/docs/_clef/Setup.md @@ -1,9 +1,4 @@ ---- -title: Advanced setup ---- - - -# Setting up Clef +# Advanced setup This document describes how Clef can be used in a more secure manner than executing it from your everyday laptop, in order to ensure that the keys remain safe in the event that your computer should get compromised. diff --git a/docs/_clef/apis.md b/docs/_clef/apis.md index 318aa9f9c4..0c09d6b3c0 100644 --- a/docs/_clef/apis.md +++ b/docs/_clef/apis.md @@ -34,9 +34,16 @@ process output for confirmation-requests. * The UI app prompts the user accordingly, and responds to the `signer` * The `signer` signs (or not), and responds to the original request. +### More resoruces + +* Changelog for [External API](developers/extapi_changelog.md) +* Changelog for [UI API](developers/intapi_changelog.md) +* Documentation about [Datatypes](developers/datatypes.md) + + ## External API -See the [external api changelog](extapi_changelog.md) for information about changes to this API. +See the [external api changelog](developers/extapi_changelog.md) for information about changes to this API. ### Encoding - number: positive integers that are hex encoded @@ -529,7 +536,7 @@ See `pythonsigner`, which can be invoked via `python3 pythonsigner.py test` to p All methods in this API uses object-based parameters, so that there can be no mixups of parameters: each piece of data is accessed by key. -See the [ui api changelog](intapi_changelog.md) for information about changes to this API. +See the [ui api changelog](developers/intapi_changelog.md) for information about changes to this API. OBS! A slight deviation from `json` standard is in place: every request and response should be confined to a single line. Whereas the `json` specification allows for linebreaks, linebreaks __should not__ be used in this communication channel, to make diff --git a/docs/_clef/datatypes.md b/docs/_clef/developers/datatypes.md similarity index 100% rename from docs/_clef/datatypes.md rename to docs/_clef/developers/datatypes.md diff --git a/docs/_clef/extapi_changelog.md b/docs/_clef/developers/extapi_changelog.md similarity index 100% rename from docs/_clef/extapi_changelog.md rename to docs/_clef/developers/extapi_changelog.md diff --git a/docs/_clef/intapi_changelog.md b/docs/_clef/developers/intapi_changelog.md similarity index 100% rename from docs/_clef/intapi_changelog.md rename to docs/_clef/developers/intapi_changelog.md diff --git a/docs/_clef/index.md b/docs/_clef/index.md deleted file mode 100644 index 070e2e5868..0000000000 --- a/docs/_clef/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Clef -root: .. -permalink: /clef/ ---- -{% for p in site.clef %} -* [{{ p.title }}]({% include link.html url=p.url %}) -{% endfor %} \ No newline at end of file