Educate with a single best path (do not list all the override methods)

Educate with working code examples

Bullet point key points, procedures, and steps to promote progression

Use shorter sentences with simpler words (3rd grade) to prevent ambiguity

Trigger action by beginning each sentence with a verb

Write in the viewpoint of the user's wants, not what Branch wants

Keep is simple (KISS) (1 -> 2 -> 3)

Don't repeat yourself (DRY) (this can be found here)

Bullets and sections must have double new line spacing in between

Indention is 4 spaces

Search works best when content is not duplicated

Only add periods if more than one sentence

Titles # Title

Sections ## Section

Category - #### Section

Content - content

Complete [Integrate your app](#dialog-code?ios=create-deep-link&android=install-branch)

Complete [Integrate your app](#dialog-code)

ios, android, adobe, cordova, mparticleAndroid, mparticleIos, titanium, reactNative, unity, xamarin

Content pages are kept in the img/pages

Example images used in ingredients are kept in the img/ingredients

![image](http://i.imgur.com/dyfhN0L.png)

Hosted by Algolia Docsearch

Localhost scrapes production

Production is scraped once a day

Prevent search results by adding production url to stop_urls (config)

framework http://www.mkdocs.org/

design https://github.com/squidfunk/mkdocs-material

extensions https://github.com/facelessuser/pymdown-extensions

docsearch config https://github.com/algolia/docsearch-configs/blob/master/configs/branchmetrics.json

not recommended

mkdocs gh-deploy

readme http://www.mkdocs.org/about/contributing/

update to repo git subtree add --prefix lib/mkdocs https://github.com/mkdocs/mkdocs master --squash

add locally pip install --editable lib/mkdocs

remove locally sudo rm /usr/local/bin/mkdocs && rm /Library/Python/2.7/site-packages/mkdocs.egg-link

readme http://squidfunk.github.io/mkdocs-material/customization/#theme-development

add to repo git subtree add --prefix lib/mkdocs-material https://github.com/squidfunk/mkdocs-material master --squash

update to repo git subtree pull --prefix lib/mkdocs-material https://github.com/squidfunk/mkdocs-material master --squash

test live update in /materials

prod code in /src

• cd lib/mkdocs-material

• yarn install

• yarn build (will build /material but fail on /site -> okay)

updated files

• lib/mkdocs-material/src/partials/footer.html

• lib/mkdocs-material/src/partials/header.html

• lib/mkdocs-material/src/partials/search.html

• lib/mkdocs-material/src/partials/nav.html

• lib/mkdocs-material/src/base.html

• lib/mkdocs-material/src/assets/javascripts/application.js