Quartz 4

EdgeDB 3.0 initial documentation

5 min read

Questions

  • If SDL syntax changes, how to reflect that in documentation with version switcher? All SDL examples will need to change globally with the version switcher.
    • We will provide two separate SDL code blocks
  • How to add something to a synopsis in SDL/DDL references (for custom access policy errors)?
    • We will provide two separate synopsis code blocks

Tools

Todo

doc-v3-sdl-new-syntax

  • Revisit Introspection “guide” after triggers PR has been merged Todo
    • I’m not updating SDL here until that merge since all of the content is being moved elsewhere. I’m not sure what that would do to the merge between these two branches.
    • Completed on doc-v3-introspection-new-sdl branch.
      • Merge doc-v3-introspection-new-sdl branch after triggers have been merged Todo
  • Fix instances of extending not yet nested Todo
    • I nested some of these after learning the new syntax, but the ones I completed before that still use the un-nested syntax.
  • Revert extending nestings for anything other than links and properties Todo
    • Per Yury, this change only applies for links and properties
  • Write new 3.0 syntax for properties and links (and types?) Todo
  • If client docs are versioned, update SDL examples in those docs
    • docs/clients/graphql/cheatsheet.rst|17 col 4|
    • docs/clients/graphql/graphql.rst|10 col 4|
    • docs/clients/graphql/index.rst|31 col 4|
    • docs/clients/http/index.rst|16 col 4|
    • We will simply replace the existing SDL examples above with the new syntax once 3.0 has launched.

Merged features

CLI

  • All things dev workflow, not just watch.
  • Version pinning?
  • Probably cloud-related stuff (but ask cloud team if that’s ready)

Unmerged features

Nothing to document (?)

Graph View

Backlinks