I2P Documentation Writing Guidelines

Mon, 01 Jan 0001 00:00:00 +0000

Purpose: Maintain consistency, accuracy, and accessibility across I2P technical documentation

Core Principles

1. Verify Everything

Never assume or guess. All technical statements must be verified against:

Current I2P source code (https://i2pgit.org/I2P_Developers/i2p.i2p/src/branch/master )
Official API documentation (https://i2p.github.io/i2p.i2p/
Configuration specifications /docs/specs/
Recent release notes /releases/

Example of proper verification:

❌ BAD: "The ClientApp interface probably requires three constructor parameters."
✅ GOOD: "The ClientApp interface requires this constructor signature: 
 public MyClientApp(I2PAppContext context, ClientAppManager manager, String[] args)"

2. Clarity Over Brevity

Write for developers who may be encountering I2P for the first time. Explain concepts fully rather than assuming knowledge.

I2P Router Troubleshooting Guide

Mon, 01 Jan 0001 00:00:00 +0000

I2P routers fail most commonly due to port forwarding issues, insufficient bandwidth allocation, and inadequate bootstrap time. These three factors account for over 70% of reported problems. The router requires at least 10-15 minutes after startup to fully integrate into the network, 128 KB/sec minimum bandwidth (256 KB/sec recommended), and proper UDP/TCP port forwarding to achieve non-firewalled status. New users often expect immediate connectivity and restart prematurely, which resets integration progress and creates a frustrating cycle. This guide provides detailed solutions for all major I2P issues affecting versions 2.10.0 and later.

Documentation on I2P - The Invisible Internet Project

I2P Documentation Writing Guidelines

Core Principles

1. Verify Everything

2. Clarity Over Brevity

I2P Router Troubleshooting Guide