AW docs: add README and TOC
This adds a README.md to //android_webview/docs/, which will render when
navigating to http://go/webview-docs
(https://chromium.googlesource.com/chromium/src/+/HEAD/android_webview/docs/).
The README refers to http://go/clank-webview, which I intend to always
include useful content, although hope someday this will be limited to
useful-for-googlers-only info, instead of
necessary-for-basic-development.
This also adds a navbar.md (see
https://gerrit.googlesource.com/gitiles/+/HEAD/Documentation/markdown.md#navigation-bar),
to link to other docs pages, and to make this feel more like its own site.
This also includes Table of Contents to the testing instructions, since
it's lengthy.
[email protected], [email protected]
Bug: 918221
Test: Upload to gerrit > open file > click "gitiles".
Change-Id: I56a521c7d4672f1d0c3fa6efc1401a8cfbcbec98
Reviewed-on: https://chromium-review.googlesource.com/c/1464935
Reviewed-by: Richard Coles <[email protected]>
Commit-Queue: Nate Fischer <[email protected]>
Cr-Commit-Position: refs/heads/master@{#631270}diff --git a/android_webview/docs/README.md b/android_webview/docs/README.md
new file mode 100644
index 0000000..a3c13fe
--- /dev/null
+++ b/android_webview/docs/README.md
@@ -0,0 +1,30 @@
+# WebView developer documentation
+
+**Shortlink:** http://go/webview-docs
+
+This directory contains developer documentation for Android WebView.
+
+*** promo
+Googlers may wish to consult http://go/clank-webview for Google-specific
+developer guides.
+***
+
+Please see the markdown files in this directory for detailed developer guides.
+
+## What is Android WebView?
+
+Android WebView is an Android system component for display web content. This
+(and the related Android classes) are implemented by the code in the
+`//android_webview/` folder.
+
+Android WebView is a content embedder, meaning it depends on code in
+`//content/` and lower layers (ex. `//net/`, `//base/`), but does not depend on
+sibling layers such as `//chrome/`.
+
+## Want to use WebView in an Android app?
+
+Please consult https://developer.android.com/reference/android/webkit/WebView,
+and the related classes in the `android.webkit` package. You may also be
+interested in out
+[`androidx.webkit`](https://developer.android.com/reference/androidx/webkit/WebViewCompat)
+API documentation.
diff --git a/android_webview/docs/navbar.md b/android_webview/docs/navbar.md
new file mode 100644
index 0000000..c69c951
--- /dev/null
+++ b/android_webview/docs/navbar.md
@@ -0,0 +1,7 @@
+# WebView docs (go/webview-docs)
+
+* [Home][home]
+* [Test instructions](/android_webview/docs/test-instructions.md)
+* [Commandline flags](/android_webview/docs/commandline-flags.md)
+
+[home]: /android_webview/docs/README.md
diff --git a/android_webview/docs/test-instructions.md b/android_webview/docs/test-instructions.md
index 169a2cca..05c5105 100644
--- a/android_webview/docs/test-instructions.md
+++ b/android_webview/docs/test-instructions.md
@@ -1,5 +1,7 @@
# WebView Test Instructions
+[TOC]
+
## Android Instructions
Please follow the instructions at
