Bläddra i källkod

Added contributing guide for docs

Casey Grun 10 år sedan
förälder
incheckning
605073fd12
1 ändrade filer med 7 tillägg och 0 borttagningar
  1. 7 0
      docs/api/CONTRIBUTING.md

+ 7 - 0
docs/api/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+Contributing to the documentation
+=================================
+
+- To link to the page for `ClassName`, use `[page:ClassName link title]` (or just `[page:ClassName]`). Use `[page:ClassName.memberName]` to link to a class member (a property or method) called `memberName` on the page for `ClassName`. You can write `[page:.memberName]` to link to a property or method called `memberName` on the same page.
+- Use `[example:exampleName title]` (ot just `[example:exampleName]`) to link to the example `threejs.org/examples/#exampleName`.
+- Document a property by writing `<h3>[property:TypeName propertyName]</h3>`/
+- Document a method using `<h3>[method:ReturnType methodName]</h3>`.