Skip to content

Reading the docs

Summary

  • A page in the "Learn" section will typically teach you about a concept or feature and then link to one or more pages in the "Tool" sections so you can learn how to implement it.
  • You can also go directly to the "Tool" sections if you already know what you want to do and just need the technical details.

The documentation is organized into two sections:

  • Learning sections.

    • Learn: tutorials and explanations.

  • Tool sections.

    • CLI: the Nextmv Command Line Interface (CLI).
    • Python SDK: a Software Development Kit (SDK) for Python developers.
    • Cloud API: an HTTP API for developers to integrate with the Nextmv platform.
    • Nextpipe: a Python package providing a framework for Decision Workflows.
    • Nextroute: a Go and Python package for solving Vehicle Routing Problems (VRP).
    • Other SDKs: more Software Development Kits (SDKs) for integrating with Gurobi and Scikit-learn.

The Learn section holds all the tutorials and explanations to get acquainted with the Nextmv platform. You should start here if:

  • You are brand new to Nextmv and want to learn how to use it.
  • You are looking to understand and implement a feature of the Nextmv platform.
  • You are looking for a tutorial to get a lay of the land on a specific topic.

The tool sections hold specific documentation for each of the tools available as part of the platform. These sections are more technical and do not dive deeply into the concepts behind the platform. You should start here if:

  • You are already familiar with the Nextmv platform and want to use a specific tool.

A page in the "Learn" section will typically teach you about a concept or feature and then link to one or more pages in the "Tool" sections so you can learn how to implement it. However, if you already know what you want to do and just need the technical details, you can go directly to the "Tool" sections.

Our documentation loosely follows the Divio documentation system, which separates docs into four categories:

Learning-oriented step-by-step guides that take you by the hand in learning and using a specific topic. Meant for absolute beginners.

Goal-oriented directions to accomplish a specific task. Meant for users already having certain knowledge and understanding of the topic.

Information-oriented technical descriptions of the "machinery". Reference guides have only one job: to describe. Meant for advanced users who want to understand the complete feature set of a tool.

Understanding-oriented discussions meant to clarify and illuminate a particular topic. Meant for users who want to understand the "why" behind a feature or tool.

You can expect to find the following types of pages in the different sections. This is not a strict categorization, but rather a general guideline to help you navigate the docs.

  • Learn: tutorials and explanations.
  • Tools: tutorials, how-to guides and technical reference.