Closed andycui97 closed 1 year ago
Given the PR description, I focused my review on the newly created RTD pages under internals
section, i.e.,
graph_breakdown.rst
codegen.rst
These pages look fairly good as internal documentation to quickly capture essence of our major data structures (e.g., NodeCollection
), which is important to remember + build on the past work.
If we eventually intend internals
documentation to become a more user/contributor-facing whitepaper detailing how the system works, then it needs more polishing/fleshing-out. However, this level of refinement is not necessary at the moment as our current intention is to have it mostly for internal use.
Given the PR description, I focused my review on the newly created RTD pages under
internals
section, i.e.,
graph_breakdown.rst
codegen.rst
These pages look fairly good as internal documentation to quickly capture essence of our major data structures (e.g.,
NodeCollection
), which is important to remember + build on the past work.If we eventually intend
internals
documentation to become a more user/contributor-facing whitepaper detailing how the system works, then it needs more polishing/fleshing-out. However, this level of refinement is not necessary at the moment as our current intention is to have it mostly for internal use.
Sgtm. Agree, right now just want to put rough ideas in internals
so we at least have something to point to. Don't expect these to be user facing or even heavily referenced by most contributors.
Description
Various Documentation fixes for Oct
Type of change
How Has This Been Tested?
Local doc build