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

Troubleshooting section major update

Open izmalk opened this issue 2 years ago • 2 comments

What is the goal of this PR?

Add content for a Troubleshooting section.

What are the changes implemented in this PR?

Renamed, restructured, and added the content to the Troubleshooting.

izmalk avatar Aug 17 '23 15:08 izmalk

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 Aug 17 '23 15:08 typedb-bot

I think a lot of this could use a rewrite, but I've done a bit for now.

benjaminasmall avatar Aug 24 '23 10:08 benjaminasmall