Skip to main content

Documentations

As we continue to build new products and new features, it's imperative that we document changes as we go. Documentation in this context is documentation from developers to developers. At its core, good documentation helps answering technical question and explain the reasoning behind decisions made at the given time. It provides context and clarity to other developers that come after you.

Things to know:

  1. This is the repo for dev-doc.
  2. https://dev-docs.ncontracts.com is the site. You have to be on the VPN to access it.
  3. This is a collaborative effort. Everyone should feel empowered to contribute to these dev-sourced docs, regardless of your time with the company
  4. If you see a hole in this information, add to it
  5. It goes through the general PR process so your additions will be vetted by others in the org

These dev docs are only as good as we make them