Docs

[luciewho]

https://geti2p.net/en/docs

Docs.pdf

[Shoalsteed]

We should add a research section as well probably and move the Papers to it

[luciewho]

Research section of Docs

Working off of the IA below:

Should I disregard what is currently on the main menu (Impressum, Vulnerability Response Process)? Is "Papers on I2P" and "Academic Papers and Peer Reviews" the same? Is "Presentations, Tutorials, Articles, and Interviews" and "Talks" the same? The "Academic Research" page (https://geti2p.net/en/research) seemed important, but isn't on canva IA. Seems like an intro to research? Do we need anything on this page?

[Shoalsteed]

The Vulnerability Process - that one I am not sure where it should go. I think it applies best to the research. I think I ran out of steam when I was making that canva chart.... Papers on I2P can go - it is the same as academic papers The academic papers are different than the content in the presentations section. The presentation section actually has some dead links too I think...

[luciewho]

Put together most of the pages for Docs

Docs.pdf

Some questions/comments that came up for me:

On canva IA: Router Message Protocol is under Network (is under wildcard Router category on wireframe, long with Other Router Topics) Network Database is under Cryptography (is under Network on wireframe. Maybe Cryptography category since it has pages on cryptography?)

“The lowest-level API used for clients (applications) to send and receive traffic to a router.” “Distributed storage and retrieval of information about routers and clients.” Add as tagline on cards? Cut down the ones that are over two lines long.

Double-checking that “Application Layer API and Protocols” is the section for the API section with screenshots? Only one page (BOB) has potential screenshots. Do “End-to-End Transport API and Protocols” and “Client-to-Router Interface API and Protocol” need screenshots as well? They are currently cards under Application.

Some pages under “Application Layer API and Protocols” have no links. What to do for wireframe? Grayed-out card?

Canva has a “Meet Your Maintainers/Get Involved” category. Should this replace the “Research” category at the top and allow Research its own category as a card?

[Shoalsteed]

Let's hand sort this together on Monday. It has been a while since I looked at this and I have probably missed some things or sorted into non-optimal categories! I need IDK to have a look too once we get this in order.

[Shoalsteed]

I2P Application Layer

Application Development Overview and Guide Naming and Address Book Address Book Subscription Feed Commands Plugins Overview Plugin Specification Managed Clients Embedding the router in your application Bittorrent over I2P I2PControl Plugin API hostsdb.blockfile Format Configuration File Format

Application Layer API and Protocols High-level, easy-to-use APIs for applications written in any language to send and receive data.

I2PTunnel I2PTunnel Configuration SOCKS Proxy HTTP Proxy CONNECT Proxy IRC Proxy SOCKS IRC Proxy Streamr Proxy HTTP Bidir Proxy SAM Protocol SAMv2 Protocol SAMv3 Protocol BOB Protocol *** - deadlink

End-to-End Transport API and Protocols The end-to-end protocols used by clients for reliable and unreliable communication.

Streaming Library Streaming Protocol Specification Streaming Javadoc Datagrams Datagram Javadoc

Client-to-Router Interface API and Protocol The lowest-level API used for clients (applications) to send and receive traffic to a router. Traditionally used only by Java applications and higher-level APIs.

I2CP - I2P Control Protocol / API overview I2CP Specification I2CP API Javadoc Common data structures specification Data Structures Javadoc

[Shoalsteed]

I2P Network Technical Documentation Technical Introduction ***** should the copy about old apps be moved to Application section??? Threat model and analysis Comparisons to other anonymous networks Specifications Protocol stack chart

[Shoalsteed]

Router Message Protocol I2P is a message-oriented router. The messages sent between routers are defined by the I2NP protocol.

I2NP - I2P Network Protocol Overview I2NP Specification I2NP Javadoc Common data structures specification Encrypted Leaseset specification Data Structures Javadoc

Other Router Topics Naming and addressbook Strict Countries?? ( should this go in software privacy guide??) Router software updates Router reseed specification Native BigInteger Library Time synchronization and NTP Performance Configuration File Format GeoIP File Format

[Shoalsteed]

End-to-End Encryption How client messages are end-to-end encrypted by the router.

ECIES-X25519-AEAD-Ratchet encryption for destinations ECIES-X25519 encryption for routers ElGamal/AES+SessionTag encryption ElGamal and AES cryptography details

Network Database Distributed storage and retrieval of information about routers and clients.

Network database overview, details, and threat analysis Cryptographic hashes Cryptographic signatures Red25519 signatures Router reseed specification Base32 Addresses for Encrypted Leasesets

Tunnels Selecting peers, requesting tunnels through those peers, and encrypting and routing messages through these tunnels.

Peer profiling and selection Tunnel routing overview Garlic routing and "garlic" terminology Tunnel building and encryption ElGamal/AES for build request encryption ElGamal and AES cryptography details Tunnel building specification (ElGamal) Tunnel building specification (ECIES-X25519) Low-level tunnel message specification Unidirectional Tunnels Peer Profiling and Selection in the I2P Anonymous Network 2009 paper (pdf), not current but still generally accurate

Transport Layer The protocols for direct (point-to-point) router to router communication. Transport layer overview NTCP TCP-based transport overview and specification NTCP2 specification SSU UDP-based transport overview SSU specification NTCP transport encryption SSU transport encryption Transport Javadoc NTCP Javadoc SSU Javadoc

[Shoalsteed]

Developer's Guides and Resources

MOST OF THIS IS ALREADY IN GET INVOLVED New Developer's Guide ( Get Involved) New Translator's Guide ( Get Involved) Monotone Guide ( make note that this is old ) Developer Guidelines ( Get Involved ) Javadocs on the standard internet: Server 1 Note: always verify that javadocs are current by checking the release number. Javadocs inside I2P: Server 3 Note: always verify that javadocs are current by checking the release number. ???

Embedding the router in your application ( this is already in application layer docs) How to Set up a Reseed Server ( get involved) Ports used by I2P ( In Advanced Software guide) ( should it be duplicated eleswear? Automatic updates to development builds inside I2P ( get involved dev guides) Updating the wrapper manually ???? User forum ( Contact) Developer forum inside I2P ( Contact ) Bug tracker ( get Involved) I2P Source exported to GitHub (get involved) I2P Source Git Repo inside I2P(get involved) Source translation at Transifex ( get involved)

[Shoalsteed]

Roadmap and Proposals Roadmap Proposals To Do List (not current) Ancient invisiblenet I2P documents (2003) The ancient I2P mailing list 2004-07 to 2006-10

[Shoalsteed]

The Invisible Internet Project Technical Overview.zip

add: Task list? to roadmap section

[luciewho]

Updated Docs. A few comments/Qs in the blue circles, reiterated below:

• Should title be changed to "Technical Documentation"
• Two cards do not have taglines
• Two cards share the same tagline
• Some tagline are 3 lines long. It is a bit crowded. A few options here: make purple part bigger for all cards, make font smaller for all cards, cut down 3 lines to 2
• I shortened Application to App in the first two cards under I2P Application Layer because it was too long
• For Roadmap and Proposals, is Development Roadmaps two separate pages named 1) Development 2) Roadmaps or one page (as it is currently shown). There were no bullet points next to the title so I wasn't sure

Docs.pdf

[Shoalsteed]

Updated Docs. A few comments/Qs in the blue circles, reiterated below:

• Should title be changed to "Technical Documentation" Yes

• Two cards do not have taglines yup - need to come up with something

• Two cards share the same tagline End-to-End Transport API and Protocols

"The end-to-end protocols used by clients for reliable and unreliable communication."

• Some tagline are 3 lines long. It is a bit crowded. A few options here: make purple part bigger for all cards, make font smaller for all cards, cut down 3 lines to 2 Could we make the card bigger?

• I shortened Application to App in the first two cards under I2P Application Layer because it was too long that works

• For Roadmap and Proposals, is Development Roadmaps two separate pages named 1) Development 2) Roadmaps or one page (as it is currently shown). There were no bullet points next to the title so I wasn't sure There is only one roadmap, so we can call it Development Roadmap or roadmap

Docs.pdf

[luciewho]

The Research category that on the previous wireframe, are we moving that from the Tech Docs? Is it going to the Support page?

[luciewho]

Bigger cards

Docs.pdf

[luciewho]

Docs.pdf

Latest version with skeleton wireframes of each page. The Overview section and some of the other sections have the copy inserted (in red for revision if needed).

[Shoalsteed]

regarding https://www.figma.com/file/RBaCbkTXWS3FMDGAtHcIjc/Information-Architecture---I2P-Website?node-id=0%3A1

above is how the research docs are on the site now. Each has a page.

Metrics, Papers , presentations, are there own thing. So a card for each. The docs: research page, open questions and VRP could be one card linking to one page with an index?

[luciewho]

Want to make sure. In that case the info architecture will look like this:

The cards on the Docs page:

When you click on each card, some of the pages would look like this, with a single sub-page:

This is how the rest of the cards on the Docs page are operating, with a bunch of sub-pages nested within each card. But since Research doesn't have all the sub-pages it is a single link.

Does this make sense and is this okay?

[Shoalsteed]

I think it is okay - it makes it easier to navigate visually.