[WireGuard] README.md refers to doc/protocol.md

Daniel Kahn Gillmor dkg at fifthhorseman.net
Thu Jun 30 21:21:00 CEST 2016

hi Jason and other wireguard folks--

README.md refers to doc/protocol.md, but there is no doc/ directory that
i can see.  This is presumably because the git repo has been curated and
the doc directory got moved to some other repo.  Should README.md get
cleaned-up to remove the reference, or to point to some public URL like
https://www.wireguard.io/protocol/ ?

In general, i'd be happy to see documentation like the stuff at
https://www.wireguard.io/protocol/ stored directly in the code repo,
because then technical documentation and code can be cleanly
synchronized (an old version of the code might be different than
whatever's on the website at the moment someone reads it).

I do recognize that you wouldn't want to put the entire website in the
source repository, though, and i'm not sure what the best way would be
to keep the website and the latest tip of the source repo in sync.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 948 bytes
Desc: not available
URL: <http://lists.zx2c4.com/pipermail/wireguard/attachments/20160630/aa854c8b/attachment.asc>

More information about the WireGuard mailing list