From 6929a02842262c4c29705ddd99a07a4874d83a03 Mon Sep 17 00:00:00 2001
From: jeff <jeff@bepis>
Date: Fri, 12 Aug 2022 09:58:54 -0700
Subject: [PATCH] set up links to new docs pages

---
 docs/dns-overview.md        | 36 ++++++++++++++++++++++++++++++++++++
 docs/high-level-overview.md | 19 +++++++++++++++++++
 docs/readme.md              |  5 +++++
 3 files changed, 60 insertions(+)
 create mode 100644 docs/dns-overview.md
 create mode 100644 docs/high-level-overview.md

diff --git a/docs/dns-overview.md b/docs/dns-overview.md
new file mode 100644
index 000000000..d3fcab22a
--- /dev/null
+++ b/docs/dns-overview.md
@@ -0,0 +1,36 @@
+# DNS in Lokinet
+
+Lokinet uses dns are its primary interface for resolving, mapping and querying resources inside of lokinet.
+This was done not because DNS is *good* protocol, but because there is almost no relevent userland applications that are incapable of interacting with DNS, across every platform.
+Using DNS in lokinet allows for the most zero config setup possible with the current set of standard protocols.
+
+Lokinet provides 2 internal gtld, `.loki` and `.snode`
+
+## .snode
+
+The `.snode` gtld is used to address a lokinet router in the form of `<zbase32 encoded public ed25519 identity key>.snode`.
+Traffic bound to a `.snode` tld will have its source authenticatable only if it originates from another valid lokinet router.
+Clients can also send traffic to and from addresses mapped to `.snode` addresses, but the source address on the service node side is ephemeral.
+In both cases, ip traffic to addresses mapped to `.snode` addresses will have the destination ip rewritten by the lokinet router to be its local interface ip, this ensures traffic stays on the lokinet router' interface for snode traffic and preventing usage as an exit node.
+
+## .loki
+
+The `.loki` gtld is used to address anonymously published routes to lokinet clients on the network.
+
+<!-- (todo: keyblinding info) -->
+
+## What RR are provided?
+
+All `.loki` domains by default have the following dns rr synthesized by lokinet:
+
+* `A` record for initiating address mapping
+* `MX` record pointing to the synthesizesd `A` record
+* free wildcard entries for all of the above.
+
+Wildard entries are currently only pointing
+
+All `.snode` domains have by defult just an `A` record for initiating address mapping.
+
+Additionally both `.loki` and `.snode` can optionally provide multiple `SRV` records to advertise existence of services on or off of the name.
+
+<!-- (//todo: document and verify srv record limitations) -->
diff --git a/docs/high-level-overview.md b/docs/high-level-overview.md
new file mode 100644
index 000000000..1d2baea84
--- /dev/null
+++ b/docs/high-level-overview.md
@@ -0,0 +1,19 @@
+## onion routing overview
+
+<!-- todo: how is traffic transported (encryption, onion etc.) for somebody knowing nothing about LLARP) -->
+
+<!-- todo: are there any techniques available to circumvent blocking of Lokinet traffic? (not at the moment) -->
+
+<!-- todo: how does path multiplexing work? -->
+
+## endpoint zmq api
+
+<!-- todo: endpoint authentication (dns records) -->
+
+## DNS
+
+<!-- todo: how does LN handle DNS requests -->
+
+<!-- todo: how are loki addresses looked up -->
+
+<!-- todo: hoes does ONS work right now (info on lookup redundancy) -->
diff --git a/docs/readme.md b/docs/readme.md
index 1bb99f2e9..3f113f5b7 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -6,14 +6,19 @@ This is where Lokinet documentation lives.
 
 [How is Lokinet different to \[insert network technology name here\] ?](net-comparisons.md)
 
+<!-- [How does Lokinet work?](high-level-overview.md) -->
+
 [How Do I use Lokinet?](ideal-ux.md)
 
+[Lokinet and DNS](dns-overview.md)
+
 [What Lokinet can't do](we-cannot-make-sandwiches.md)
 
 ## Lokinet Internals
 
 [High level layout of the git repo](project-structure.md)
 
+
 [Build Doxygen Docs for internals](doxygen.md)
 
 ## Lokinet (SN)Application Developer Portal