Skip to content
This repository was archived by the owner on Feb 21, 2026. It is now read-only.
This repository was archived by the owner on Feb 21, 2026. It is now read-only.

Dev Docs #38

@mpacer

Description

@mpacer

In conversation with @MSeal I raised an issue that as a new developer it is somewhat difficult to begin contributing to this project. Out of concerns around bus-factor and long term sustainability, we arrived at the idea that we should have better developer documentation.

This came up in part because of #37 and how much is changing as a result of introducing external reference based storage. I in part wouldn't know how to review it because I don't know how it relates to the current way of internally organizing all of the logic.

My proposal is that before making massive architectural changes, we should try to express how the pieces are intended to work together today. That way the changes can be described at a higher level that is distinct from the details of the implementation.

In the nteract meeting, @captainsafia suggested that we create this issue and tag @willingc who has been amazing for helping solidify efforts like these.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions