Wire MkDocs site

Author: squarejesse

.gitignore

@@ -15,4 +15,10 @@ build
 generated
 
 # Maven
-plugin*.xml
+plugin*.xml
+
+# Special Mkdocs files
+docs/3.x
+docs/changelog.md
+docs/contributing.md
+docs/index.md

CHANGELOG.md

@@ -1,12 +1,17 @@
 Change Log
 ==========
 
-Version 3.0.0-alpha03 *(2019-06-22)*
-------------------------------------
+Version 3.0.0-alpha03
+---------------------
+
+_2019-06-22_
+
  * Similar to alpha02, but with proper `wire-runtime` multiplatform artifacts.
 
-Version 3.0.0-alpha02 *(2019-06-21)*
-------------------------------------
+Version 3.0.0-alpha02
+---------------------
+
+_2019-06-21_
 
  * New: Experimental multiplatform runtime.
 
@@ -38,8 +43,10 @@ Version 3.0.0-alpha02 *(2019-06-21)*
  * Fix: Generate labels for WireField annotation.
  * Fix: Wrap oneof error message properly.
 
-Version 3.0.0-alpha01 *(2019-03-14)*
-------------------------------------
+Version 3.0.0-alpha01
+---------------------
+
+_2019-03-14_
 
  * New: Kotlin Generator
 
@@ -162,8 +169,10 @@ Version 3.0.0-alpha01 *(2019-03-14)*
   * Fix: Return subclass type instead of abstract parameterized type for newBuilder.
   * Fix: Validate enum namespace in file context are unique.
 
-Version 2.2.0 *(2016-06-17)*
-----------------------------
+Version 2.2.0
+-------------
+
+_2016-06-17_
 
  * New: Support for `map` type in the schema, compiler, and runtime!
  * New: `AndroidMessage` base class consolidates everything required for supporting Android and will
@@ -178,14 +187,18 @@ Version 2.2.0 *(2016-06-17)*
    guaranteed to never be `null`.
 
 
-Version 2.1.2 *(2016-04-15)*
-----------------------------
+Version 2.1.2
+-------------
+
+_2016-04-15_
 
  * Fix: Gson type adapter now deserializes JSON null literals to empty list for repeated fields.
 
 
-Version 2.1.1 *(2016-02-01)*
-----------------------------
+Version 2.1.1
+-------------
+
+_2016-02-01_
 
  * New: `reserved` keyword is now supported and enforced.
  * Fix: Defer reflection-based lookup of enum method until first use to avoid
@@ -194,8 +207,10 @@ Version 2.1.1 *(2016-02-01)*
  * Fix: Adjacent string literals are not correctly concatenated.
 
 
-Version 2.1.0 *(2016-01-18)*
-----------------------------
+Version 2.1.0
+-------------
+
+_2016-01-18_
 
  * **Empty lists of packed values were being encoded incorrectly.** In Wire 2.0.x our message
    adapters incorrectly included empty lists for `[packed=true]` rather than omitting them. This is
@@ -206,26 +221,32 @@ Version 2.1.0 *(2016-01-18)*
  * New: Wire now includes a sample code generation for service interfaces.
 
 
-Version 2.0.3 *(2016-01-04)*
-----------------------------
+Version 2.0.3
+-------------
+
+_2016-01-04_
 
  * New: `ProtoAdapter.get` overload which returns an adapter given an instance of a message.
  * New: `@Nullable` annotations are emitted for `optional` fields when using `--android`.
  * Fix: Remove the need for `javac` to generate synthetic accessor methods in the generated code.
    This results in smaller code size and less method references (for Android users).
 
 
-Version 2.0.2 *(2015-12-14)*
-----------------------------
+Version 2.0.2
+-------------
+
+_2015-12-14_
 
  * Fix: Exclude unknown fields when encoding JSON and drop unknown fields when parsing JSON.
  * Fix: Ensure JSON encoding and decoding works in the default generation mode (not just
    `--compact`) by always adding `@WireField` metadata to message fields.
  * Fix: Update to JavaPoet 1.4 for more accurate generation of valid Java code.
 
 
-Version 2.0.1 *(2015-11-12)*
-----------------------------
+Version 2.0.1
+-------------
+
+_2015-11-12_
 
  * Fix: Do not emit `case` statements for aliased enum constant values. The first constant for a
    value will be returned when deserializing.
@@ -234,8 +255,10 @@ Version 2.0.1 *(2015-11-12)*
    the dependencies of an excluded member were retained despite the member itself being omitted.
 
 
-Version 2.0.0 *(2015-10-23)*
-----------------------------
+Version 2.0.0
+-------------
+
+_2015-10-23_
 
 Wire 2 is a backwards-incompatible release. It makes breaking changes to the compiler, runtime,
 extensions, and generated code. These changes aren’t made lightly as we’ve endured the upgrade in
@@ -311,55 +334,68 @@ no longer need a `Wire` instance!
  * Fix: Extension fields must not be `required`.
 
 
-Version 1.8.0 *(2015-06-27)*
-----------------------------
+Version 1.8.0
+-------------
+
+_2015-06-27_
 
  * New: `oneof` support!
  * Fix: Correct serialization of repeated unknown fields.
  * Fix: Removed superfluous `private` modifier on enum constructor.
  * Warning: The 'protoparser' library was updated to version 4.0. This changes the type passed to
    any `ServiceWriter` implementations.
 
+Version 1.7.0
+-------------
 
-Version 1.7.0 *(2015-03-05)*
-----------------------------
+_2015-03-05_
 
  * New: Messages implement `Serializable`. The serialized form follows protobuf encoding, so
    renaming fields is safe as long as tags are consistent. (Renaming classes is unsafe, however).
    Note that extension fields are deserialized as unknown fields.
 
-Version 1.6.1 *(2015-01-16)*
-----------------------------
+Version 1.6.1
+-------------
+
+_2015-01-16_
 
  * New: `--quiet` and `--dry-run` command-line arguments.
  * Fix: Handle an extension registry with zero or only one item.
  * Okio dependency bumped to 1.2.0.
 
 
-Version 1.6.0 *(2014-10-23)*
-----------------------------
+Version 1.6.0
+-------------
+
+_2014-10-23_
 
  * Fix: Correctly throw `IOException` when parsing bad input fails.
  * Fix: Ensure emitted code references to `Arrays.asList` correctly compiles in some edge cases.
  * '__UNDEFINED__' enum value has been removed.
 
 
-Version 1.5.2 *(2014-09-15)*
-----------------------------
+Version 1.5.2
+-------------
+
+_2014-09-15_
 
  * New: '__UNDEFINED__' enum value represents values that the generated code is unable to handle.
  * New: Service writer implementation can now be specified on the command-line.
 
 
-Version 1.5.1 *(2014-06-18)*
-----------------------------
+Version 1.5.1
+-------------
+
+_2014-06-18_
 
  * New: Generate interface definition for a `Service` with a partial list of methods.
  * Okio dependency bumped to 1.0.0.
 
 
-Version 1.5.0 *(2014-04-22)*
-----------------------------
+Version 1.5.0
+-------------
+
+_2014-04-22_
 
  * New: Options on enums and enum values are now supported.
  * New: Options ending with `.redacted` on fields will omit values from `toString`.
@@ -368,8 +404,10 @@ Version 1.5.0 *(2014-04-22)*
  * Okio dependency bumped to 0.9.0.
 
 
-Version 1.4.0 *(2014-04-22)*
-----------------------------
+Version 1.4.0
+-------------
+
+_2014-04-22_
 
  * Replace Wire's ByteString class with the one from Okio (https://github.com/square/okio).
    **This is a breaking API change**.
@@ -385,29 +423,37 @@ Version 1.4.0 *(2014-04-22)*
  * Fix a bug where no some extension dependencies were not detected.
 
 
-Version 1.3.3 *(2014-03-28)*
-----------------------------
+Version 1.3.3
+-------------
+
+_2014-03-28_
 
  * New: Support service declarations as roots. The request and response types of their methods will
    be included.
 
 
-Version 1.3.2 *(2014-03-27)*
-----------------------------
+Version 1.3.2
+-------------
+
+_2014-03-27_
 
  * Fix: Enum value duplicate check now correctly looks at names instead of values.
 
 
-Version 1.3.1 *(2014-03-25)*
-----------------------------
+Version 1.3.1
+-------------
+
+_2014-03-25_
 
  * New: Automatically add Maven plugin's generated source as a compilation root.
  * Fix: Correct Maven plugin's 'no arguments' flag to work properly.
  * Fix: Support extend declarations nested inside message types.
 
 
-Version 1.3.0 *(2014-03-21)*
-----------------------------
+Version 1.3.0
+-------------
+
+_2014-03-21_
 
  * New: Empty repeated fields are now initialized to an empty collection.
  * New: Emit field options. Use `--no_options` flag to disable.
@@ -417,23 +463,28 @@ Version 1.3.0 *(2014-03-21)*
 
 Note: This version is not backwards compatible with code generated from previous versions.
 
+Version 1.2.0
+-------------
 
-Version 1.2.0 *(2013-11-01)*
-----------------------------
+_2013-11-01_
 
  * New: `--registry_class` compiler argument emits a class with a list of extensions suitable for
    passing to the `Wire` constructor.
  * Fix: Ensure all trailing whitespace is trimmed on documentation.
 
 
-Version 1.1.1 *(2013-10-23)*
-----------------------------
+Version 1.1.1
+-------------
+
+_2013-10-23_
 
  * Fix: Correct parsing and emission of multi-line documentation.
 
 
-Version 1.1.0 *(2013-10-22)*
-----------------------------
+Version 1.1.0
+-------------
+
+_2013-10-22_
 
  * New: Support for message options.
  * New: Check for duplicate field tag numbers.
@@ -444,15 +495,19 @@ Version 1.1.0 *(2013-10-22)*
  * Fix: Avoid shadowing fields named "result", "other", or "o".
 
 
-Version 1.0.1 *(2013-08-27)*
-----------------------------
+Version 1.0.1
+-------------
+
+_2013-08-27_
 
  * New: Support reading directly from `InputStream`.
  * New: Add '`other == this`' shortcut in generated `equals()` methods.
 
 
-Version 1.0.0 *(2013-08-23)*
-----------------------------
+Version 1.0.0
+-------------
+
+_2013-08-23_
 
 Initial version.
 

CONTRIBUTING.md

@@ -1,17 +1,38 @@
 Contributing
 ============
 
-If you would like to contribute code you can do so through GitHub by forking
-the repository and sending a pull request.
+Keeping the project small and stable limits our ability to accept new contributors. We are not
+seeking new committers at this time, but some small contributions are welcome.
 
-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 clean build`. Checkstyle failures
-during compilation indicate errors in your style and can be viewed in the
-`checkstyle-result.xml` file.
+If you've found a security problem, please follow our [bug bounty][security] program.
 
-Before your code can be accepted into the project you must also sign the
-[Individual Contributor License Agreement (CLA)][1].
+If you've found a bug, please contribute a failing test case so we can study and fix it.
 
+Before code can be accepted all contributors must complete our
+[Individual Contributor License Agreement (CLA)][cla].
 
- [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
+
+Code Contributions
+------------------
+
+Get working code on a personal branch with tests passing before you submit a PR:
+
+```
+./gradlew clean check
+```
+
+Please make every effort to follow existing conventions and style in order to keep the code as
+readable as possible.
+
+Contribute code changes through GitHub by forking the repository and sending a pull request. We
+squash all pull requests on merge.
+
+
+Committer's Guides
+------------------
+
+ * [Releasing][releasing]
+
+ [cla]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
+ [releasing]: http://square.github.io/wire/releasing/
+ [security]: http://square.github.io/wire/security/