cuelang.org/go@v0.10.1/internal/mod/README.md (about)

     1  ## WIP Modules FAQ/README/etc
     2  
     3  This is a WIP file in which we capture aspects of the modules implementation
     4  that need documenting. Some take the form of FAQ-like questions, others are
     5  simply details which we need to ensure are documented.  Some of the points
     6  listed below could be part of a modules reference doc, others a modules FAQ...
     7  We don't seek to make a decision on what docs/FAQs etc should exist, just use
     8  this opportunity to capture the bits that need coverage.
     9  
    10  Some of the questions below are presented with answers, many are just left here
    11  as a TODO.
    12  
    13  The goal of this doc is to capture things in a central VCS-based file, alongside
    14  the code that "raises" the question/similar.
    15  
    16  * Documentation around defaulting the value of `CUE_REGISTRY` (or whatever we
    17    call it) to the central registry.
    18  * Document that `pkg`, `usr` and `gen` directories cannot co-exist with modules,
    19    and make clear what users (especially of `gen`) should probably do instead.
    20  * Document potential future vendor behaviour.
    21  * Document what we mean by a "canonical" version, how this differs from a
    22    "well-formed" version. Present examples of each.