TBR docs and website tweaks
- fixes comments that didn't render as such on github
- adds pointers from website to canonical (github) docs
for contributing instructions and coding guidelines
Change-Id: I75b6dfdc956bffc5e476ad75197570e30a117e23
MultiPart: 1/2
diff --git a/contributing/coding-guidelines.md b/contributing/coding-guidelines.md
index 1314284..2645970 100644
--- a/contributing/coding-guidelines.md
+++ b/contributing/coding-guidelines.md
@@ -34,10 +34,11 @@
Things move around, so its best to examine your local installation for
the latest arrangement.
- <!--
- Suggestions for how to name things (hyphens vs underscores).
- Using optional arguments - variadics/varargs vs Options objects.
- -->
+<!--
+TODO:
+- Suggestions for how to name things (hyphens vs. underscores).
+- Using optional arguments: variadic functions / varargs vs. Options structs.
+-->
## Go
@@ -70,11 +71,10 @@
is useful when trying to reproduce failures that may not occur when the
random number generator is seeded differently.
- <!-- explain modules, expect, timekeeper? -->
- <!--
- Describe dependency management (apis vs. impls,
- what can depend on what).
- -->
+<!-- TODO: Explain modules, expect, timekeeper? -->
+
+<!-- TODO: Describe dependency management (apis vs. impls, what can depend on
+what). -->
## VDL
@@ -96,7 +96,7 @@
Follow the [Node.js Style Guide]. Use our [.jshintrc].
- <!-- Documentation generation - jsdoc -->
+<!-- TODO: Documentation generation (jsdoc). -->
## Shell
