diff --git a/doc/README b/doc/README index d40f5d988d..395fc07dc5 100644 --- a/doc/README +++ b/doc/README @@ -1,3 +1,3 @@ -This directory contains some high level documentation for the code. We should strive to keep it up-to-date, but don't take it as the absolute truth. +This directory contains some high level documentation for the code. -A good place to start is 'overview.md' +WARNING: much of this is out-of-date. It stil may be helpful, though. diff --git a/doc/overview.md b/doc/overview.md index f64d12920d..4d074dfaf3 100644 --- a/doc/overview.md +++ b/doc/overview.md @@ -1,4 +1,4 @@ -# Documentation for edX code (mitx repo) +# Documentation for edX code (edx-platform repo) This document explains the general structure of the edX platform, and defines some of the acronyms and terms you'll see flying around in the code.