| Version 111 (modified by , 10 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.
The website tasks can be found on website.
Getting Started
- Install Monotone (see http://www.i2p2.i2p/newdevelopers.html)
- Check out the i2p.www branch.
- Pick a task below (and your name to the Who column).
Need help? Ask in #i2p-dev on IRC
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
Unclaimed / Help needed
| Page or Protocol | Status | Who | Notes |
| A Gentle Introduction to I2P http://www.i2p2.i2p/how_intro | http://trac.i2p2.i2p/wiki/intro Non-technical intro aimed at users, 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) | ||
| I2P Technical Introduction http://www.i2p2.i2p/techintro.html | First pass progressing | Mathiasdm | Technical intro, see More Notes below |
| JBigI http://www.i2p2.i2p/jbigi | Mathiasdm | Needs some more overview, reword for current implementation | |
| AES256/CBC Transport Encryption http://www.i2p2.i2p/techintro.html#op.crypto | |||
| AES256/CBC Tunnel Message Encryption http://www.i2p2.i2p/techintro.html#op.crypto | Mathiasdm | ||
| 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 | ||
| Garlic Encryption ElGamal?/AES + Session Tag http://www.i2p2.i2p/how_elgamalaes | welt | ||
| Tunnel Building circles-and-arrows (picture) | new | dr|z3d | Bring me your rough graphical drafts! |
| Floodfill circles and arrows | new | dr|z3d | |
| I2CP http://www.i2p2.i2p/i2cp | Port messages spec from 2003 PDF - Make new i2cp_spec.html page, use same format as http://www.i2p2.i2p/i2np_spec | ||
| Javadocs http://docs.i2p2.i2p/ | welt | Needs regeneration, add router, streaming lib, SAM and BOB docs | |
| API http://www.i2p2.i2p/api | Just linked to http://www.i2p2.i2p/how for now, should we remove link from menu? | ||
| All German technical pages | Either update after English page is updated, or put a note at the top saying it is out of date | ||
| Development guide http://www.i2p2.i2p/applications | Improve the guide add more info on 'developing using the I2P api'. | ||
| Network Comparison http://www.i2p2.i2p/how_networkcomparisons | |||
| Use Cases | new | Feel free to base your work on this: http://smeghead.i2p/i2pdocs/use_cases.html (Markdown version here: http://smeghead.i2p/i2pdocs/use_cases.pdc ). Use Cases is currently linked to from the front page rewrite, see: http://trac.i2p2.i2p/wiki/Content |
Review needed
| Page or Protocol | Status | Who | Notes |
| I2PTunnel http://www.i2p2.i2p/i2ptunnel | 1st pass done, (add your name if you've reviewed) | hottuna | This is just awful. Needs a complete rewrite. |
| BOB http://www.i2p2.i2p/bob.html | new | sponge | Done! Please review for spelling and grammar. |
| Index of technical docs http://www.i2p2.i2p/how.html | 1st pass done, pls review | zzz | See More Notes below. Should probably rename from how.html to something like technical_index.html |
| Low-level crypto http://www.i2p2.i2p/how_cryptography | 1st pass done and reviewed (add your name if you've reviewed) | zzz, Mathiasdm | |
| Transport Overview http://www.i2p2.i2p/transport | new - 1st pass done, pls review | zzz | Transport bids, priorities, selection, interaction |
| SSU http://www.i2p2.i2p/udp | 2nd pass done, pls review | zzz | Formal spec moved to new http://www.i2p2.i2p/udp_spec |
| NTCP http://www.i2p2.i2p/ntcp | 1st pass done, pls review | zzz | moved discussion to new http://www.i2p2.i2p/ntcp_discussion |
| 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 |
| Tunnel build details http://www.i2p2.i2p/tunnel-alt-creation | 1st pass done, pls review | zzz | |
| Garlic Routing http://www.i2p2.i2p/how_garlicrouting | 1st pass done, pls review | zzz | Now is an overview of "garlic" terminology and has references to the origins of the term |
| Tunnel Routing http://www.i2p2.i2p/how_tunnelrouting | 1st pass done, pls review | zzz | Now contains an overview of tunnel terminology |
| Common Data Structures http://www.i2p2.i2p/common_structures_spec | 1st pass done, pls review | welt (zzz reviewing) | new - Port from 2003 PDF |
| I2NP http://www.i2p2.i2p/i2np http://www.i2p2.i2p/i2np_spec | 1st pass done, pls review | welt (zzz reviewing) | spec page is new - Port messages spec from 2003 PDF |
| Floodfill / netdb http://www.i2p2.i2p/how_networkdatabase.html | 1st pass done, (add your name if you've reviewed) | zzz, Mathiasdm | 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 |
| Datagrams http://www.i2p2.i2p/datagrams | 1st pass done, pls review | zzz | |
| Streaming http://www.i2p2.i2p/streaming | 1st pass done, pls review | zzz | |
| SAM http://www.i2p2.i2p/sam http://www.i2p2.i2p/samv2 http://www.i2p2.i2p/samv3 | 1st pass done, pls review | zzz | |
| 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 | 1st pass done, pls review | duck | Moved discussion and alternatives to separate page |
| Peer selection and profiling http://www.i2p2.i2p/how_peerselection | 1st pass done, pls review | zzz | |
| German index page http://www.i2p2.i2p/how_de.html | 2nd pass done. Need to check links to Javadoc once it is online | HungryHobo?,SqueezeIt? | checked spelling,grammar and links; broken links are: Java-Dokumentation zur Streaming-Bibliothek (englisch), Java-Dokumentation zu I2NP (englisch), Java-Dokumentation zur Transportschicht (englisch), Java-Dokumentation zu NTCP (englisch), Java-Dokumentation zu SSU (englisch) |
| German plugins page http://www.i2p2.i2p/plugins_de.html | 1st pass done, pls review | HungryHobo? | |
| Supported Applications | new, done | smeghead | Review here: http://smeghead.i2p/i2pdocs/review/supported_applications.html |
| Router Software Update Spec http://www.i2p2.i2p/updates | new, please review | zzz | |
| Performance http://www.i2p2.i2p/performance | please review, fix SessionTags? | duck | For SessionTags?, see javadoc of TransientSessionKeyManager?.java |
In Progress
| Page or Protocol | Status | Who | Notes |
| Monotone http://www.i2p2.i2p/monotone.html | in progress | smeghead | Needs HTML-ification |
| Videos | new | xor, jaywalk, zzz, chrisk | 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 |
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
