updating docs for release (#1511)

square · Jul 30, 2019 · aef1d5b · aef1d5b
1 parent e694076
commit aef1d5b
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 25 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -9,7 +9,7 @@ Now is a great time to adopt it and provide feedback before the stable release.
 * New standalone library! [Shark](shark.md) is the heap analyzer that powers LeakCanary 2, and it can run in any Java VM. It comes with a [CLI](shark.md#shark-cli): you can now run `shark-cli analyze-process com.example.myapp` from your computer.
 * New Heap Explorer directly on device! Open a Heap Analysis in LeakCanary, tap the options menu and select "Heap Explorer". This is still experimental and not very user friendly, contributions welcome!
 * **Large API rewrite** to improve usability. If you used the alpha with a customized configuration, there are breaking changes. Of note: LeakSentry became [AppWatcher](/api/leakcanary-object-watcher-android/leakcanary/-app-watcher/), RefWatcher became [ObjectWatcher](/api/leakcanary-object-watcher/leakcanary/-object-watcher/), AndroidExcludedRefs became [AndroidReferenceMatchers](/api/shark-android/shark/-android-reference-matchers/), AnalysisResultListener became [OnHeapAnalyzedListener](/api/leakcanary-android-core/leakcanary/-on-heap-analyzed-listener/), AndroidLeakTraceInspectors became [AndroidObjectInspectors](/api/shark-android/shark/-android-object-inspectors/).
-* The entire API surface is now documented and the documentation is available on this website: try the search bar at the top and **LeakCanary API ∨** in the navigation menu.
+* The entire API surface is now documented and the documentation is available on this website: see the **LeakCanary API** tab at the top.
 * Removed the **dependency on Android X**. No more configuration issues! [#1462](https://github.com/square/leakcanary/issues/1462) 
 * Added **Proguard rules** for LeakCanary and ObjectWatcher. [#1500](https://github.com/square/leakcanary/pull/1500) 
 * Display LeakCanary version in the About screen. [#1448](https://github.com/square/leakcanary/issues/1448) 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,8 +1,7 @@
 # Contributing
 
-If you would like to contribute code to LeakCanary you can do so through GitHub by
-forking the repository and sending a pull request.
+You are most welcome to contribute code, answer [StackOverflow questions](http://stackoverflow.com/questions/tagged/leakcanary?sort=active), help manage GitHub issues and review pull requests.
 
-When submitting code, please make every effort to follow existing conventions
-and style in order to keep the code as readable as possible. Please also make
-sure your code compiles by running `./gradlew build`.
+If you would like to contribute code to LeakCanary you can do so through GitHub by
+forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible.
diff --git a/docs/support.md b/docs/support.md
@@ -1,14 +1,12 @@
 # LeakCanary Support
 
-If you're looking for support for LeakCanary:
+If you're looking for help with LeakCanary:
 
 * Learn the [Fundamentals](fundamentals.md)
 * Try the [code recipes](recipes.md)
 * Read the [FAQ](https://square.github.io/leakcanary/faq/)
 * Watch [recorded presentations](recorded-presentations.md)
 * Read [blog articles](blog-articles.md)
-* Check out the StackOverflow [LeakCanary tag](http://stackoverflow.com/questions/tagged/leakcanary?sort=active) and ask a question
-
-Feel free to edit this file to add links to online communities that can help developers investigate LeakCanary leaks.
+* Ask a question [on StackOverflow](http://stackoverflow.com/questions/tagged/leakcanary?sort=active)
 
 
diff --git a/docs/upgrading-to-leakcanary-2.0.md b/docs/upgrading-to-leakcanary-2.0.md
@@ -1,3 +1,10 @@
+LeakCanary 2 is a major rewrite. High level changes:
+
+* New heap analyzer, reimplemented from scratch to use 10 times less memory ([see Shark](shark.md)).
+* APIs updated to simplify configuration and provide access to the new heap analyzer.
+* Internals rewritten to 100% Kotlin.
+* Multiple leaks detected in one analysis, grouped per leak type
+
 ## Dependencies
 
 ### Before

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,6 +19,8 @@ theme:
   palette:
     primary: 'deep-orange'
     accent: 'deep-purple'
+  feature:
+    tabs: true
 
 markdown_extensions:
   - smarty
@@ -45,27 +47,29 @@ nav:
   - 'Fundamentals': fundamentals.md
   - 'Code recipes': recipes.md
   - 'FAQ': faq.md
-  - 'Shark': shark.md
-  - 'Stack Overflow ⏏': https://stackoverflow.com/questions/tagged/leakcanary?sort=active
+  - 'Change Log': changelog.md
+  - 'Help & Community':
+    - 'Support': support.md
+    - 'Upgrading to LeakCanary 2': upgrading-to-leakcanary-2.0.md
+    - 'Recorded Presentations': recorded-presentations.md
+    - 'Blog Articles': blog-articles.md
+    - 'Stack Overflow ⏏': https://stackoverflow.com/questions/tagged/leakcanary?sort=active
+    - 'Contributing': contributing.md
+    - 'Code of Conduct': code_of_conduct.md
+  - 'Shark':
+    - 'Overview': shark.md
+    - 'Shark API':
+      - 'Shark': api/shark/shark/index.md
+      - 'Extension: Shark Android': api/shark-android/shark/index.md
+      - 'Core: Graph': api/shark-graph/shark/index.md
+      - 'Core: Hprof': api/shark-hprof/shark/index.md
+      - 'Core: Logs': api/shark-log/shark/index.md
   - 'LeakCanary API':
     - 'LeakCanary': api/leakcanary-android-core/leakcanary/index.md
     - 'ObjectWatcher Android': api/leakcanary-object-watcher-android/leakcanary/index.md
     - 'Extension: Instrumentation tests': api/leakcanary-android-instrumentation/leakcanary/index.md
     - 'Extension: Separate process': api/leakcanary-android-process/leakcanary/index.md
     - 'Core: ObjectWatcher': api/leakcanary-object-watcher/leakcanary/index.md
-  - 'Shark API':
-    - 'Shark': api/shark/shark/index.md
-    - 'Extension: Shark Android': api/shark-android/shark/index.md
-    - 'Core: Graph': api/shark-graph/shark/index.md
-    - 'Core: Hprof': api/shark-hprof/shark/index.md
-    - 'Core: Logs': api/shark-log/shark/index.md
-  - 'Change Log': changelog.md
-  - 'Support': support.md
-  - 'Upgrading to LeakCanary 2': upgrading-to-leakcanary-2.0.md
-  - 'Blog Articles': blog-articles.md
-  - 'Recorded Presentations': recorded-presentations.md
-  - 'Contributing': contributing.md
-  - 'Code of Conduct': code_of_conduct.md
 
 # Google Analytics. Add export LEAKCANARY_GOOGLE_ANALYTICS_KEY="UA-XXXXXXXXX-X" to your ~/.bashrc
 google_analytics: