[Nfd-dev] nfd documentation

[Beichuan Zhang]

Dear All,

After the internal release of v.0.1 of NFD, we’re now working on the next release v0.2, which will be publicized to the ICN community in general. The most critical thing needed is better documentation, and again, we plan to do it with a team effort. 

We’ve created a separate repository for an NFD Developer’s Guide: git at git.irl.cs.ucla.edu:papers/nfd-docs.git (if you don’t have access, please contact Alexander Afanasyev <alexander.afanasyev at ucla.edu>). This document explains the internals of the NFD, and the target readers are people who may want to extend and improve NFD.  Each section corresponds to a module in NFD, and its content should include (1) the design and structure of the module, (2) the interaction between other modules, (3) explanation of major components of this module and their interactions, (4) figures to help understand the text. The hope is that after reading this guide, other developers would have good ideas of how NFD was designed and implemented, which will help them to plan any changes. 

Right now you’ll only find section titles in the repository. We will assign the writing of each section to the main developer who wrote the code, and you’ll soon receive Redmine emails about the assignment. The deadline is June 8, after which we’ll have one week to do integration. As always, please let us know ASAP if there’s any problem.

Thanks!

Beichuan