Version 54 (modified by 9 years ago) (diff) | ,
---|
Task list for updating the docs and specs on the website. This is roughly in the same order as the protocol stack http://www.i2p2.i2p/protocols , but upside down.
Add your name below if you want to work on a subsection.
General guidelines:
- Remove obsolete information
- Verify information accuracy by checking java source
- Remove blog-style history and evolution and discussion, or move to separate discussion pages
- Add links to references, particularly docs on freehaven.net http://freehaven.net/anonbib/topic.html
- Remove dead links to i2p.net
- Improve readability, navigation
Page or Protocol | Status | Who | Notes |
Homepage http://www.i2p2.i2p/index.html | in progress | smeghead, duck, dr|z3d, ReturningNovice?, Mathiasdm | http://trac.i2p2.i2p/wiki/Content |
FAQ http://www.i2p2.i2p/faq.html | underway | dr|z3d, duck | http://trac.i2p2.i2p/wiki/faq |
GLOSSARY OF TERMS | nascent | dr|z3d, darrob | http://trac.i2p2.i2p/wiki/glossary NEW!! Let's make this comprehensive! |
Team http://www.i2p2.i2p/team | duck | Identify new (vacant) team roles | |
Index of technical docs http://www.i2p2.de/how.html | See More Notes below. Should probably rename from how.html to something like technical_index.html | ||
I2P Technical Introduction http://www.i2p2.i2p/techintro.html | Technical intro, see More Notes below | ||
A Gentle Introduction to I2P http://www.i2p2.de/how_intro | smeghead | http://trac.i2p2.i2p/wiki/intro Non-technical intro, see More Notes below. Rename to gentle_introduction.html and link to it from index.html, and remove from how.html (which is for technical docs, not end-user docs) | |
Use Cases | new, in progress | smeghead | |
Supported Applications | new, in progress | smeghead | |
Videos | new | xor, jaywalk, zzz | Compile list of technical and instructional videos. Include kugg's talk, the HOPE talk, echelon's talk from last year, and everything telecomix has done. See http://pad.telecomix.org/video (current) and http://instruction.telecomix.org/ (older) |
Threat model http://www.i2p2.i2p/how_threatmodel | in progress | smeghead | This may be helpful - or not: http://l6nvqsqivhrunqvs.tor2web.com/index.php?do=topic&id=11566 |
Low-level crypto http://www.i2p2.i2p/how_cryptography | 1st pass done, pls review | zzz, Mathiasdm | |
AES256/CBC Transport Encryption http://www.i2p2.i2p/techintro.html#op.crypto | |||
Transport Overview http://www.i2p2.i2p/transport | new - 1st pass done, pls review | zzz | Transport bids, priorities, selection, interaction |
NTCP http://www.i2p2.i2p/ntcp | |||
SSU http://www.i2p2.i2p/udp | 1st pass done, pls review | zzz | Formal spec moved to new http://www.i2p2.i2p/udp_spec |
AES256/CBC Tunnel Message Encryption http://www.i2p2.i2p/techintro.html#op.crypto | Mathiasdm | ||
Tunnel Messages http://www.i2p2.i2p/tunnel_message_spec (formerly in http://www.i2p2.i2p/tunnel-alt.html#tunnel.preprocessing ) | new - 1st pass done, pls review | zzz | Moving tunnel-alt section 2.1 to new http://www.i2p2.i2p/tunnel_message_spec |
Tunnels http://www.i2p2.i2p/tunnel-alt | Needs lots of work esp. on crypto - why does it say things are decrypted first and then encrypted at the end??? Very confusing - Moved discussion and alternatives to new http://www.i2p2.i2p/tunnel_discussion | ||
Tunnel build details http://www.i2p2.i2p/tunnel-alt-creation | zzz | Needs minor tweaks for VTBM | |
Garlic Encryption ElGamal?/AES + Session Tag http://www.i2p2.i2p/how_elgamalaes | welt | ||
Common Data Structures http://www.i2p2.i2p/common_structures_spec | new | welt (zzz reviewing) | Port from 2003 PDF |
I2NP http://www.i2p2.i2p/i2np http://www.i2p2.i2p/i2np_spec | spec page is new | welt (zzz reviewing) | Port messages spec from 2003 PDF |
Tunnel Building circles-and-arrows | new | ||
Floodfill / netdb http://www.i2p2.i2p/how_networkdatabase.html | 1st pass done, pls review | zzz | Major rewrite done, old discussion and history moved to new page http://www.i2p2.i2p/netdb_discussion which can remain somewhat obsolete if we want |
Floodfill circles and arrows | new | ||
I2CP http://www.i2p2.i2p/i2cp | Port messages spec from 2003 PDF | ||
Streaming http://www.i2p2.i2p/streaming | |||
Datagrams http://www.i2p2.i2p/datagrams | |||
SAM http://www.i2p2.i2p/sam http://www.i2p2.i2p/samv2 http://www.i2p2.i2p/samv3 | |||
BOB | new | sponge | need overview and spec |
Plugins http://www.i2p2.i2p/plugins http://www.i2p2.i2p/plugin_spec | new - 1st pass done, pls review | zzz | Mostly copied from http://zzz.i2p/i2p/plugins/ and the spec was copied over pretty much as-is |
Naming / addressbook http://www.i2p2.i2p/naming | |||
Peer selection and profiling http://www.i2p2.i2p/how_peerselection | 1st pass done, pls review | zzz | |
Javadocs http://docs.i2p2.i2p/ | welt | Needs regeneration, add router docs | |
All Deutsch how* pages | Either fix up after english page is done, or add a note that it is obsolete and refer to the english page | ||
Development guide | new | Add a guide on 'developing using the I2P api'. |
MORE NOTES
<Mathiasdm> I'm not sure about the difference between 'How does it work?' and 'Tech intro'
<Mathiasdm> hm, perhaps the tech intro is the place for an RFC-style document on the core
<smeghead> Mathiasdm: "How does it work" should be a non-technical intro
<smeghead> Mathiasdm: for joe sixpack, not techies
<smeghead> Mathiasdm: that's why i think it should be renamed to something like "A Gentle Introduction to I2P", as implied here: http://duck.i2p/i2p2de-rewrite/site/
<Mathiasdm> okay, so perhaps 'Tech intro' should become 'Technical documentation' then
<smeghead> the current how.html should remain the index to the technical docs imo, and a proper technical high-level overview should be written
<Mathiasdm> I'd also want a more technical spec like Tor has: http://gitweb.torproject.org/tor.git?a=blob_plain;hb=HEAD;f=doc/spec/tor-spec.txt
…snip…
<smeghead> actually, i think it will be easier to move how_intro.html from the list in how.html and use it as the basis for gentle_introduction.html
<smeghead> and techintro.html should replace how_intro.html in how.html
<smeghead> that makes more sense