Index: pkg/docgen/doc/README.txt |
diff --git a/pkg/docgen/doc/README.txt b/pkg/docgen/doc/README.txt |
new file mode 100644 |
index 0000000000000000000000000000000000000000..554e159a1ddece1081a3a26c8f43215eed3f5717 |
--- /dev/null |
+++ b/pkg/docgen/doc/README.txt |
@@ -0,0 +1,8 @@ |
+The sdk-introduction.md file in this directory is used as the introductory |
+text on the documentation site if the SDK is included. However, if docgen |
+is run from a snapshot we won't be able to find that file, and it may |
+not exist in an SDK download that doesn't include the pkg directory. So |
+we have a copy of that text as a string constant named DEFAULT_SDK_INTRODUCTION |
+in docgen.dart. If the text of sdk-introduction.md is updated you should also |
+update the corresponding text in docgen.dart. |
+ |