Merge pull request #1 from tnorbye/gh-pages

Add docs

Author: tnorbye

README.md

@@ -1,6 +1,16 @@
 Custom Lint Rules
 =================
 
+The lint source code contains a lot of documentation on how to write
+custom checks; this git repository contains a snapshot of this
+documentation which you can read here:
+
+* [Full API Guide](https://tnorbye.github.io/android-custom-lint-rules/book.html)
+* [Other docs](https://tnorbye.github.io/android-custom-lint-rules/index.html)
+
+Lint
+----
+
 The [Android `lint` tool](http://developer.android.com/tools/help/lint.html) is a static code
 analysis tool that checks your project source files for potential bugs and optimization
 improvements for correctness, security, performance, usability, accessibility, and

docs/.gitignore

@@ -0,0 +1,5 @@
+markdeep.min.js
+todo.md
+blank.md.html
+spell-check.sh
+spelling-ok.txt

docs/README.md

@@ -0,0 +1,12 @@
+Android Lint
+============
+
+(Note that many files in this docs folder has the extension `.md.html`
+instead of just `.md`. That means that they can be opened in a
+browser for better visualization (such as syntax highlighting of code
+snippets) but are readable and editable as markdown.)
+
+Let's go there right now: [Link](README.md.html)
+
+There is also a pre-rendered HTML version of the API Guide
+[here](book.html) suitable for online hosting.

docs/README.md.html

@@ -0,0 +1,42 @@
+Android Lint
+============
+
+Android Lint is a static analysis tool (which despite the name is not
+limited to Android, and within Google for example is used to analyze
+Java and Kotlin server side code as well as Android and even desktop
+software like IDEs.)
+
+Lint's focus is on finding bugs (whether they are related to
+correctness, performance, security, internationalization, usability and
+so on); it's not a source code style checker.
+
+Available documentation:
+
+* [Lint Features](features.md.html)
+* [Recent Changes](changes.md.html)
+* Documents for users of lint, in the `usage` folder:
+  - [How to suppress incidents](usage/suppressing.md.html)
+  - [How to use baselines](usage/baselines.md.html)
+  - [How to use `lint.xml` files](usage/lintxml.md.html)
+  - [Environment variables and properties](usage/variables.md.html)
+* Documents for authors of additional lint checks, in the
+  `api-guide` folder:
+  - [Complete Book](book.md.html), containing all of the below
+    documents as chapters, suitable for offline reading
+  - [Basics](api-guide/basics.md.html)
+  - [A Sample Lint Check](api-guide/example.md.html)
+  - [Publishing a Lint check](api-guide/publishing.md.html)
+  - [Unit Testing](api-guide/unit-testing.md.html)
+  - [Adding Quick Fixes](api-guide/quickfixes.md.html)
+  - [Terminology](api-guide/terminology.md.html)
+  - [Partial analysis](api-guide/partial-analysis.md.html)
+  - [Frequently Asked Questions](api-guide/faq.md.html)
+* Documents for lint internals, intended for developers of lint
+  itself, in the `internal` folder:
+  - [Guidelines](internal/guidelines.md.html)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Documentation History:
+* March 2021: Initial version
+
+<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>