Skip to content

developer.md

Latest commit

 

History

History
20 lines (16 loc) · 1.4 KB

developer.md

File metadata and controls

20 lines (16 loc) · 1.4 KB
Raw

Building NodeKit

  • Run make build from the repo root to build the Python package; this is the canonical build path.
  • Note that npm is not used to distribute the NodeKit browser runtime (i.e. nodekit.js and nodekit.css; these ship with the Python build (see _static).

Documentation

  • To view the MkDocs site on one's local machine with live reloading, run make view-docs from the root of this repository.
  • Google-style docstrings are used in this project.
  • Roughly structuring the documentation following guidance laid out in Diátaxis.
  • The griffe-pydantic mkdocs extension is used to document pydantic models in NodeKit; see StackOverflow discussion

Documentation style nits

  • Use "NodeKit" (for general usage) or nodekit (if referring to the importable Python package). Not: nodekit, Nodekit, NK.
  • In nonfunctional code snippets, one should generally assume import nodekit as nk was run, not: import nodekit
  • Entities in NodeKit should be referred to as proper nouns; e.g.
    • "Nodes", not "nodes"
    • "Agents", not "agents", unless the general concept of agent is being discussed (e.g. "RL agents" is ok; "NodeKit agents" is not)
    • etc.
  • Mechanical Turk, not: "MTurk", "turk", "mturk", "Turk", "AMT"