design

Design Document

Contents

• Architecture: The architecture of CodePair's NestJS backend
• Yorkie Auth Webhook: Auth Webhook to prevent users from accessing unauthorized documents using a Public Key

Maintaining the Document

For significant scope and complex new features, it is recommended to write a Design Document before starting any implementation work. On the other hand, we don't need to design documentation for small, simple features and bug fixes.

Writing a design document for big features has many advantages:

• It helps new visitors or contributors understand the inner workings or the architecture of the project.
• We can agree with the community before code is written that could waste effort in the wrong direction.

While working on your design, writing code to prototype your functionality may be useful to refine your approach.

Authoring Design document is also proceeded in the same contribution flow as normal Pull Request such as function implementation or bug fixing.