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
- Make sure that possible future features (e.g. nontrivial delays, restricted routes, mid-tunnel rerouting) are clearly identified as such
Unclaimed / Help needed
| Page or Protocol | Status | Who | Notes |
| iMule mentioned alongside I2Phex and BT | new | Please don't let iMule die! It's very important! Mention it in the FAQ and any other pages mentioning apps available in I2P. Definitely mention two things: "Unlike BT, iMule uses the KaD network and thus is completely decentralized and uncensored (BT tracker sites are a single point of failure and are censored; in iMule/KaD, the tracker and search engine are both available at a single place in the client app, but they cannot be shut down or censored, because the service is distributed and decentralized) and the second thing: Please don't link just to imule.i2p (it has been down for months) but also to the trustworthy mirror http://echelon.i2p/imule/ (I'd do all of this job myself, but didn't get commit access after weeks of asking.) | |
| Tunnel Building circles-and-arrows (picture) | new | dr|z3d | Bring me your rough graphical drafts! |
| Floodfill circles and arrows | new | dr|z3d | |
| All package.html javadoc files | Review all package.html files in the source tree for accuracy. These are displayed in the javadocs. Add package.html files that are missing in important packages. | ||
| All German technical pages | new | echelon | update needed after English page is updated, but a note is at the top saying it is out of date |
| 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 | |
| Glossary http://www.i2p2.i2p/glossary | new | Doesn't have a list of useful terminology yet. Add as much as possible, keep it alphabetical. Also needs to be linked (how.html), but I haven't done that yet, since there's nothing in the glossary yet. |
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, sk7, RN | This was just awful. Needed a complete rewrite. (RN- looks good to me as of 10/08/28) |
| BOB http://www.i2p2.i2p/bob.html | new | sponge | Done! Please review for spelling and grammar.(RN- spelling and gramar ok, think topic was little over my head) |
| 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 | RN- looks good |
| JBigI http://www.i2p2.i2p/jbigi | 1st pass done, pls review | zzz | Minor editing done. |
| Transport Overview http://www.i2p2.i2p/transport | new - 1st pass done, (add your name if you've reviewed | zzz, Mathiasdm | Transport bids, priorities, selection, interaction |
| SSU http://www.i2p2.i2p/udp | 2nd pass done, pls review | zzz | (RN review looks good) Formal spec moved to new http://www.i2p2.i2p/udp_spec |
| NTCP http://www.i2p2.i2p/ntcp | 1st pass done, (add your name if you've reviewed | zzz, Mathiasdm | 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 RN-review ok |
| Tunnels http://www.i2p2.i2p/tunnel-alt | 1st pass done, pls review | zzz | Needed some work esp. on crypto - Explained why it says things are decrypted first and then encrypted at the end (zzz) - Moved discussion and alternatives to new http://www.i2p2.i2p/tunnel_discussion |
| Tunnel build details http://www.i2p2.i2p/tunnel-alt-creation | 1st pass done, pls review | zzz | RN Reviewed: looks good |
| Garlic Routing http://www.i2p2.i2p/how_garlicrouting | 1st pass done, pls review | zzz, reviewed by hottuna, RN | Now is an overview of "garlic" terminology and has references to the origins of the term (RN- review looks good) |
| Tunnel Routing http://www.i2p2.i2p/how_tunnelrouting | 1st pass done, pls review | zzz | Now contains an overview of tunnel terminology (RN review- looks good) |
| 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 |
| Garlic Encryption ElGamal?/AES + Session Tag http://www.i2p2.i2p/how_elgamalaes | 1st pass done, pls review | zzz | |
| 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 (RN review- ok if I read it slowly.) |
| I2CP http://www.i2p2.i2p/i2cp http://www.i2p2.i2p/i2cp_spec | 1st pass done, pls review | zzz | i2cp_spec.html page is new |
| Datagrams http://www.i2p2.i2p/datagrams | 1st pass done, pls review | zzz | |
| Streaming http://www.i2p2.i2p/streaming | 1st pass done, pls review | zzz | RN fixed typo songe found - fixed another typo and reviewed ok |
| SAM http://www.i2p2.i2p/sam http://www.i2p2.i2p/samv2 http://www.i2p2.i2p/samv3 | 1st pass done, pls review | zzz | |
| Javadocs http://docs.i2p2.de/ http://docs.i2p2.i2p/ | Done unless somebody wants to make a home page for it. Not sure if welt has implemented a cron job for it or not. .de is up-to-date. .i2p is not fixed yet. | welt | Regeneration, add router, streaming lib, SAM and BOB docs |
| API http://www.i2p2.i2p/api | now unused | zzz | Unlinked from everything, removed link from menu. Menu now points to http://docs.i2p2.de/javadoc/ |
| Plugins http://www.i2p2.i2p/plugins http://www.i2p2.i2p/plugin_spec | new - 1st pass done, (add your name if you've reviewed | zzz, Mathiasdm (needs additional review) | Mostly copied from http://zzz.i2p/i2p/plugins/ and the spec was copied over pretty much as-is (RN review - looks good) |
| Naming / addressbook http://www.i2p2.i2p/naming | 1st pass done, (add your name if you've reviewed) | duck, Mathiasdm | 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 | Finished version: http://smeghead.i2p/i2pdocs/supported_applications.html (RN reviewed and pushed to mtn) |
| Router Software Update Spec http://www.i2p2.i2p/updates | new, please review | zzz | RN OK |
| Performance http://www.i2p2.i2p/performance | please review, fix SessionTags? | duck | For SessionTags?, see javadoc of TransientSessionKeyManager?.java (RN review -looks good) |
| I2P protocol stack http://www.i2p2.i2p/protocols | 1st pass done, please review | Mathiasdm | RN review… notes below |
| Threat model http://www.i2p2.i2p/how_threatmodel | 1st pass done, pls review | zzz | RN review: interesting to read, spotted & fixed a typo |
| I2P Technical Introduction http://www.i2p2.i2p/techintro.html | 1st pass done, pls review | Mathiasdm | |
| A Gentle Introduction to I2P http://www.i2p2.i2p/how_intro | 1st pass done, pls review | zzz | http://trac.i2p2.i2p/wiki/intro Non-technical intro aimed at users, see More Notes below. Minor editing done. |
| Development guide http://www.i2p2.i2p/applications | 1st pass done, pls review | Mathiasdm | Improve the guide add more info on 'developing using the I2P api'. |
| German plugins spec http://www.i2p2.i2p/plugin_spec_de.html | 1st pass done, pls review | HungryHobo? | |
| AES256/CBC Transport Encryption http://www.i2p2.i2p/techintro.html#op.crypto | 1st pass done, pls review | Mathiasdm | |
| AES256/CBC Tunnel Message Encryption http://www.i2p2.i2p/techintro.html#op.crypto | 1st pass done, pls review | Mathiasdm | |
| German router update page http://www.i2p2.i2p/updates_de.html | 1st pass done, pls review | HungryHobo? | |
| Monotone http://www.i2p2.i2p/monotone.html | 1st pass done, pls review | Mathiasdm (but from smeghead) | (taken from following link and checked in - please review - zzz) HTML-ification and partial rewrite complete: http://smeghead.i2p/i2pdocs/monotone_guide.html Pandoc-ified Markdown version: http://smeghead.i2p/i2pdocs/monotone_guide.pdc Makefile and Pandoc template available: http://smeghead.i2p/i2pdocs/ |
| Network Comparison http://www.i2p2.i2p/how_networkcomparisons | 1st pass done, pls review | zzz | Older comparisons moved to http://www.i2p2.i2p/othernetworks |
In Progress
| Page or Protocol | Status | Who | Notes |
| 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) |
MORE NOTES
<RN>protocols.html
the section 'i2p tunnel layer' where it says "…read a part. Another part…" that sounds confusing to me, otherwise it looks good afik. (feel free to delete this comment if the wording changes there)
<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
Last modified 9 years ago
Last modified on Nov 6, 2010 6:45:05 PM
