typedb-docs icon indicating copy to clipboard operation
typedb-docs copied to clipboard

Update driver tutorials and pages to support TypeDB Driver 3.1 with the unified constructor

Open farost opened this issue 9 months ago • 2 comments

What is the goal of this PR?

Update driver tutorials and pages to support TypeDB Driver 3.1, specifically its unified constructor for all editions of TypeDB.

What are the changes implemented in this PR?

Remove mentions of editions and substitute new_core / new_cloud / core_driver / cloud_driverwith new / driver.

farost avatar Feb 25 '25 11:02 farost

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • [x] This change is trivial and does not require a code or architecture review.

Code

  • [ ] Packages, classes, and methods have a single domain of responsibility.
  • [ ] Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • [ ] The code is canonical and the minimum required to achieve the goal.
  • [ ] Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • [ ] Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • [ ] The code is algorithmically efficient and scalable for the whole application.

Architecture

  • [ ] Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • [ ] Any required build and release automations are updated and/or implemented.
  • [ ] Any new components follows a consistent style with respect to the pre-existing codebase.
  • [ ] The architecture intuitively reflects the application domain, and is easy to understand.
  • [ ] The architecture has a well-defined hierarchy of encapsulated components.
  • [ ] The architecture is extensible and scalable.

typedb-bot avatar Feb 25 '25 11:02 typedb-bot

I'm going to merge it once 3.1 (non-rc) is released. Until then, we should not really update the manuals with unstable code snippets.

farost avatar Feb 25 '25 11:02 farost