diff --git a/README.md b/README.md index c2a85b33a7..a0d4b69de7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +This GitHub repository contains the documentation for [GeckoView][8]. If you are looking for the code for GeckoView you can find it at [Mozilla Central][9]. + +If there is documentation that you feel is missing, or an existing document doesn't cover the aspect that you are looking for, please request it by [raising an issue][10]. + +If you have a GeckoView bug that you want to raise, please do so on our [Bugzilla][11]. + ## Get Started with GeckoView * [GeckoView Quick Start Guide][1] @@ -21,10 +27,14 @@ You can read more about GeckoView on the [wiki](https://wiki.mozilla.org/Mobile/GeckoView). -[1]:docs/geckoview-quick-start.md -[2]:javadoc/mozilla-central/org/mozilla/geckoview/doc-files/CHANGELOG.md -[3]:tutorials/geckoview-quick-start.md -[4]:tutorials/mc-quick-start.md -[5]:tutorials/contributing-to-mc.md -[6]:tutorials/native-debugging.md -[7]:docs/web-extensions.md +[1]:https://geckoview.dev/consumer/docs/geckoview-quick-start +[2]:https://geckoview.dev/javadoc/mozilla-central/org/mozilla/geckoview/doc-files/CHANGELOG.md +[3]:https://geckoview.dev/contributor/geckoview-quick-start.md +[4]:https://geckoview.dev/contributor/mc-quick-start.md +[5]:https://geckoview.dev/contributor/contributing-to-mc.md +[6]:https://geckoview.dev/contributor/native-debugging.md +[7]:https://geckoview.dev/consumer/docs/web-extensions.md +[8]:https://geckoview.dev +[9]:https://searchfox.org/mozilla-central/source/mobile/android/geckoview +[10]:https://github.com/mozilla/geckoview/issues +[11]: https://bugzilla.mozilla.org/enter_bug.cgi?product=GeckoView diff --git a/tutorials/automation.md b/consumer/docs/automation.md similarity index 99% rename from tutorials/automation.md rename to consumer/docs/automation.md index cdfae822b9..55b6357b50 100644 --- a/tutorials/automation.md +++ b/consumer/docs/automation.md @@ -1,9 +1,10 @@ --- layout: default title: Configuring GeckoView for Automation -nav_order: 4 summary: How to set environment variables, Gecko arguments, and Gecko preferences for automation and debugging. tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,debugging,automation,config,configuration,environment,variables,arguments,preferences] +nav_exclude: true +exclude: true --- ## Table of contents {: .no_toc .text-delta } diff --git a/docs/geckoview-quick-start.md b/consumer/docs/geckoview-quick-start.md similarity index 100% rename from docs/geckoview-quick-start.md rename to consumer/docs/geckoview-quick-start.md diff --git a/consumer/docs/index.md b/consumer/docs/index.md new file mode 100644 index 0000000000..ea135c823b --- /dev/null +++ b/consumer/docs/index.md @@ -0,0 +1,18 @@ +--- +layout: default +title: GeckoView Usage Documentation +nav_order: 3 +--- + +# Usage Documentation + +We are working on providing detailed usage documentation for all of GeckoView's most popular features. Here is what we have so far. + +- [GeckoView Quick Start Guide](geckoview-quick-start): +Get GeckoView up and running inside your application. +- [Interacting with Web Content](web-extensions): +Writing Web Extensions, running content scripts and interacting with Javascript running in a web page. +- [Configuring GeckoView for Automation](automation): +Get GeckoView set up on your automation system. + +If there is documentation that you feel is missing, or an existing document doesn't cover the aspect that you are looking for, please request it by raising an issue on our [documentation site](https://github.com/mozilla/geckoview/issues). diff --git a/docs/web-extensions.md b/consumer/docs/web-extensions.md similarity index 99% rename from docs/web-extensions.md rename to consumer/docs/web-extensions.md index e62b4b6a1b..ab09dfc0dd 100644 --- a/docs/web-extensions.md +++ b/consumer/docs/web-extensions.md @@ -1,8 +1,9 @@ --- layout: default title: Interacting with Web content -nav_order: 3 summary: How to interact with Web content and register WebExtensions in GeckoView. +nav_exclude: true +exclude: true --- # Interacting with Web content and WebExtensions diff --git a/tutorials/contributing-to-mc.md b/contributor/contributing-to-mc.md similarity index 99% rename from tutorials/contributing-to-mc.md rename to contributor/contributing-to-mc.md index b387cf153e..6d4f96b3e2 100644 --- a/tutorials/contributing-to-mc.md +++ b/contributor/contributing-to-mc.md @@ -1,9 +1,10 @@ --- layout: default title: Mozilla Central Contributor Guide -nav_order: 7 summary: Guide to setting up as a contributor to mozilla-central. tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,mozilla-central,bug fix,submit,patch,arcanist,arc,moz-phab,phabricator] +nav_exclude: true +exclude: true --- ## Table of contents {: .no_toc .text-delta } diff --git a/tutorials/geckoview-quick-start.md b/contributor/geckoview-quick-start.md similarity index 99% rename from tutorials/geckoview-quick-start.md rename to contributor/geckoview-quick-start.md index 24e75e01f4..892ac18864 100644 --- a/tutorials/geckoview-quick-start.md +++ b/contributor/geckoview-quick-start.md @@ -1,9 +1,10 @@ --- layout: default title: GeckoView Contributor Guide -nav_order: 3 summary: Guide to setting up as a contributor to GeckoView. tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,mozilla-central,setup,get started,compile,build,deploy,bug fix,submit,patch,arcanist,arc,moz-phab,phabricator] +nav_exclude: true +exclude: true --- ## Table of contents {: .no_toc .text-delta } diff --git a/contributor/index.md b/contributor/index.md new file mode 100644 index 0000000000..d34cdf3083 --- /dev/null +++ b/contributor/index.md @@ -0,0 +1,19 @@ +--- +layout: default +title: GeckoView Contributor Documentation +nav_order: 4 +--- + +# Contributor Site + +If you want to run GeckoView from code, or start contributing back to the project, here you will find resources to help you do that. + +- [GeckoView Contributor Quick Start Guide](geckoview-quick-start): Get GeckoView set up for development. +- [Mozilla Central Quick Start Guide](mc-quick-start): +Get Mozilla Central set up for development. +- [Mozilla Central Contributor Guide](contributing-to-mc): +Get started as a contributor to Mozilla Central. +- [Guide to Native Debugging in Android Studio](native-debugging): +Set up Android Studio for debugging native code. + +If there is documentation that you feel is missing, or an existing document doesn't cover the aspect that you are looking for, please request it by raising an issue on our [documentation site](https://github.com/mozilla/geckoview/issues). \ No newline at end of file diff --git a/tutorials/mc-quick-start.md b/contributor/mc-quick-start.md similarity index 99% rename from tutorials/mc-quick-start.md rename to contributor/mc-quick-start.md index 05bd46655d..d4f42372a6 100644 --- a/tutorials/mc-quick-start.md +++ b/contributor/mc-quick-start.md @@ -1,9 +1,10 @@ --- layout: default title: Mozilla Central Quick Start -nav_order: 6 summary: Guide to setting up as a Git contributor to mozilla-central. tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,mozilla-central,setup,compiling,mercurial,git-cinnabar] +nav_exclude: true +exclude: true --- ## Table of contents {: .no_toc .text-delta } diff --git a/tutorials/native-debugging.md b/contributor/native-debugging.md similarity index 99% rename from tutorials/native-debugging.md rename to contributor/native-debugging.md index 4ad92c3ee8..af337a2d62 100644 --- a/tutorials/native-debugging.md +++ b/contributor/native-debugging.md @@ -1,9 +1,10 @@ --- layout: default title: Debugging Native Code -nav_order: 5 summary: How to set up native debugging for GeckoView using Android Studio. tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,debugging,native,android studio] +nav_exclude: true +exclude: true --- ## Table of contents {: .no_toc .text-delta } diff --git a/index.md b/index.md index bd19dbc5d0..1faf9f7982 100644 --- a/index.md +++ b/index.md @@ -6,6 +6,8 @@ summary: GeckoView, a webview from Mozilla specifically designed for Android bro tags: [GeckoView,Gecko,mozilla,android,WebView,mobile,mozilla-central] --- +# Welcome to GeckoView + While Android offers a built-in WebView, it's not intended for building browsers, and many advanced Web APIs are disabled. Android's WebView is also a moving target: it's impossible know exactly which engine (and what version of that engine) will power a WebView on client devices. In contrast, GeckoView is: @@ -14,34 +16,27 @@ In contrast, GeckoView is: - **Self-Contained**: Because GeckoView is a standalone library that you bundle with your application, you can be confident that the code you test is the code that will actually run. - **Standards Compliant**: Like Firefox, GeckoView offers excellent support for modern Web standards. -## Get Started with GeckoView - -* [GeckoView Quick Start Guide][1] +## Using GeckoView +* [Quick Start Guide][1] +* [Usage Documentation][7] ## API Documentation * [Changelog][2] -* [API](javadoc/mozilla-central/index.html) - -## Get Started as a Contributor - -* [GeckoView Contributor Quick Start Guide][3] -* [Mozilla Central Quick Start Guide][4] -* [Mozilla Central Contributor Guide][5] -* [Guide to Configuring GeckoView for Automation][6] -* [Guide to Native Debugging in Android Studio][7] - +* [API][3] ## More information -* [GeckoView Wiki](https://wiki.mozilla.org/Mobile/GeckoView) -* [GeckoView Source Code](https://searchfox.org/mozilla-central/source/mobile/android/geckoview) -* [This Site on GitHub](https://github.com/mozilla/geckoview/) +* [GeckoView Wiki][4] +* [GeckoView Source Code][5] +* [Raise a bug on GeckoView code][8] +* [Raise a documentation bug][6] -[1]:docs/geckoview-quick-start +[1]:consumer/docs/geckoview-quick-start [2]:javadoc/mozilla-central/org/mozilla/geckoview/doc-files/CHANGELOG -[3]:tutorials/geckoview-quick-start -[4]:tutorials/mc-quick-start -[5]:tutorials/contributing-to-mc -[6]:tutorials/automation -[7]:tutorials/native-debugging +[3]:javadoc/mozilla-central/index.html +[4]:https://wiki.mozilla.org/Mobile/GeckoView +[5]:https://searchfox.org/mozilla-central/source/mobile/android/geckoview +[6]:https://github.com/mozilla/geckoview/issues +[7]:consumer/docs/index +[8]: https://bugzilla.mozilla.org/enter_bug.cgi?product=GeckoView