Repository for Branch's public documentation https://docs.branch.io
-
-
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 it simple (KISS) (
1 -> 2 -> 3
) -
Don't repeat yourself (DRY) (
this can be found here
)
-
-
- Make sure you answer
why
,what
,how
(example) with each section
- Make sure you answer
-
git clone [email protected]:branchmetrics/docs.git cd docs
-
pip install -r requirements.txt
-
mkdocs serve open http://127.0.0.1:8000
-
- Merge pull request into
master
- Create new pull request from
master
- Merge pull request from
master
intoproduction
on release days
- Merge pull request into
-
- Must be lowercase and hyphened
-
-
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
-
-
- Tabbed sections
*title*
,code
,*title*
,code
- Tabbed sections
-
-
Different page
click [here](/pages/apps/ios/)
(must have trailing slash) -
Different page anchor
click [here](/pages/apps/ios/#configure-bundle-identifier)
-
Same page anchor
click [here](#configure-bundle-identifier)
-
-
- Syntax for tips and other highlighted blocks can be found here: http://squidfunk.github.io/mkdocs-material/extensions/admonition/
-
-
Complete [Integrate your app](#dialog-code?ios=create-deep-link&android=install-branch)
-
Complete [Integrate your app](#dialog-code)
-
ios
,android
,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)
-
-
- Add
<script>window.location = "/pages/dashboard/people-based-attribution"</script>
to the top of the file
- Add
-
-
not recommended
mkdocs gh-deploy
-
-
-
update to repo
git subtree add --prefix lib/mkdocs https://github.com/mkdocs/mkdocs master --squash
-
add locally
pip install --editable lib/mkdocs
-
-
remove mkdocs
sudo rm -rf /usr/local/bin/mkdocs
-
remove mkdocs link
rm -rf /Library/Python/2.7/site-packages/mkdocs.egg-link
-
remove pip
rm -rf /Library/Python/2.7/site-packages
-
reinstall pip
curl https://bootstrap.pypa.io/get-pip.py > a.py && chmod -x a.py && sudo ./a.py
-
reinstall dependencies
-
run develop
-
-
-
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
(this is 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
-
lib/mkdocs-material/src/assets/images/favicon.png
-
-
-
- The docs should load within
1400ms
. If it takes5000ms
, please disableGhostery
(Google Analytics) andAdblocker
(the docs have AB testing)
- The docs should load within
-
- Some ad blockers prevent the search from appearing