Inside this repo, you'll find Android documentation for both the Maps SDK and Mapbox Services SDK.
To view the documentation, head over to the website.
To host this documentation locally, you'll need node.js, npm and Gatsby installed on your machine:
brew install nodejs
To install Gatsby:
npm install -g gatsby
Now navigate to this cloned projects root folder and execute:
npm install
When editing documents or working on the site, you'll most likely want to run it locally to enable hot reload editing. Tweak your pages, templates, and styles and see changes in real time. To run a locally hosted version of the documentation, follow the installation instructions above, and then within the root folder execute the develop command in terminal:
gatsby develop
This will set up a server running at http://localhost:8080.
Inside the root directory, you'll see a pages folder which contains all the documentation. It's hierarchy is meant to allow for versioning.
SDK > Version > Document
Inside the .md file, there are a few requirements to help keep consistency across documentation and organize properly.
- The document needs front-matter at the top providing a
titleandpath. - Start off the document not including a title in markdown, it's already given in the front-matter
- Add the file path inside the same SDKs
_pages.yamlfile.
Once the documentation has been updated or added, open a pull request and let CI run. After the PR is reviewed, merging into master will run CI again but this time, will deploy your changes automatically to the website.
In main directory, open the constants.js and update the version number.