Skip to content

Commit b8e4db3

Browse files
authored
Merge pull request #178 from katzenpost/fixup_docs2
Fixup document links
2 parents 2ebd087 + 45061a6 commit b8e4db3

8 files changed

Lines changed: 27 additions & 25 deletions

File tree

content/en/docs/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ type: "base"
1414
| 🔒 | **[Threat Model](/docs/threat_model)** | An evolving document defining Katzenpost's security assumptions, attack scenarios, and mitigation strategies. | [HTML](/docs/threat_model) / [PDF](/research/Threat_Model_Doc.pdf) |
1515
| 📚 | **[Literature Review](/research/Literature_overview__website_version.pdf)** | A curated review of academic literature, explaining the theoretical foundations behind Katzenpost's design decisions. | [PDF](/research/Literature_overview__website_version.pdf) |
1616
| 🎧 | **[Audio Engineering Considerations for a Modern Mixnet](/docs/audio_eng)** | Technical analysis of audio transmission challenges and solutions for modern mixnets, with a focus on usability and scalability. | [HTML](/docs/audio_eng) / [PDF](/research/Audio_Engineering_Considerations_for_a_Modern_Mixnet.pdf) |
17-
18-
17+
| 🔥 | **[Client Integration Guide](/docs/client_integration)** | Guide to integrating your application with thin client libraries | [HTML](/docs/client_integration)
18+
| 📝 | **[How to Use the Namenlos Mixnet](/docs/howto_use_namenlos_mixnet)** | Guide to using the Namenlos mixnet | [HTML](/docs/howto_use_namenlos_mixnet)]

content/en/docs/admin_guide/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2-
title: Administration guide
2+
title:
3+
linktitle: "Administration guide"
34
weight: 6
45
---
56

7+
# Administration guide
8+
69
{{% pageinfo %}}
710
Use the documentation in this section to explore how the mixnet works and to implement your own.
811
{{% /pageinfo %}}

content/en/docs/audio_eng.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
2-
title: "Audio Engineering Considerations for a Modern Mixnet"
2+
title:
3+
linkTitle: Audio Engineering Considerations for a Modern Mixnet
34
draft: false
45
slug: "/audio_eng/"
56
---
67

8+
<h1>Audio Engineering Considerations for a Modern Mixnet</h1>
9+
710
<div class="center">
811
<p>This work was supported by a grant from the Wau Holland
912
Foundation.</p>

content/en/docs/client_integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Katzenpost Client Integration Guide"
3-
linkTitle: ""
2+
title:
3+
linkTitle: Katzenpost Client Integration Guide
44
description: ""
55
categories: [""]
66
tags: [""]

content/en/docs/join_namenlos.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "How to Use the Namenlos Mixnet"
3-
linkTitle: ""
2+
title: ""
3+
linkTitle: "How to Use the Namenlos Mixnet"
44
description: ""
55
categories: [""]
66
tags: [""]
@@ -10,6 +10,8 @@ draft: false
1010
slug: "/howto_use_namenlos_mixnet/"
1111
---
1212

13+
<h1>How to Use the Namenlos Mixnet</h1>
14+
1315
<i>namenlos</i> is a Katzenpost mixnet ran by the KP team.
1416
It is our canonical example of a Katzenpost-type mixnet instance.
1517

content/en/docs/specs/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
2-
title: Specifications
2+
title:
3+
linkTitle: "Specifications"
34
weight: 6
45
draft: false
56
type: page
67
---
78

9+
# Specifications
10+
811
{{% pageinfo %}}
912
These technical specifications describe the specifics of Katzenpost protocols and implementations, and are aimed primarily at software developers.
1013
{{% /pageinfo %}}

content/en/docs/threat_model.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
title: "Threat Model"
2+
title:
33
linkTitle: "Threat Model"
44
draft: false
55
slug: "/threat_model/"
66
---
77

8+
<h1>Threat Model</h1>
9+
810
<h1 id="the-purpose-and-structure-of-this-document">The purpose and
911
structure of this document</h1>
1012
<p>This threat model document is unique in the privacy technology

content/en/pages/community.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,9 @@ menu: {main: {weight: 5}}
77
type: "pages"
88
---
99

10-
Chat with us on our zulip chat server instance hosted by Zulip:
11-
https://katzenpost.zulipchat.com/
12-
13-
14-
* The cypherpunk ideal would be if we could all use a Katzenpost mixnet
15-
to chat about ongoing katzenpost development, engineering and research
16-
efforts. Let's save that for later when we've got our newer protocols
17-
built out. For now, we can use Zulip which does not require a phone
18-
number to sign up. We've heard Zulip works well with Tor.
19-
20-
* We used to have a mailing list. If people find that useful we can
21-
bring back mailing lists.
22-
23-
* IRC (internet relay chat): we are not using IRC anymore to coordinate
24-
10+
## Chat with us
2511

12+
| Platform | Link | Description |
13+
|----------|------|-------------|
14+
| <img src="/images/zulip-icon-circle.svg" alt="Zulip Logo" width="30" height="30"> **Zulip** | [katzenpost.zulipchat.com](https://katzenpost.zulipchat.com/) | Our main chat server instance hosted by Zulip. No phone number required to sign up. Works well with Tor. |
2615

0 commit comments

Comments
 (0)