I want to preface this by saying the current documentation is extremely helpful for jump starting development (That is the reason I've been able to make a couple of PR's in the first week of jumping into the code base ). I personally feel adding ARCHITECTURE.md will add value.

The idea behind ARCHITECTURE.md is to give a broad overview of the codebase explaining what core pieces are in what files and how they tie in together. For example, here are some questions an ARCHITECTURE.md file will answer

• What important packages/frameworks are being used
• Where and how are we using elasticsearch
• What is the difference between /server and /api
• Is the client only interfacing with /server or does it also communicate with the /api
• Where are the js/ts models located?
• Broadly, what are the reasons behind picking the current stack.

Let me know what you think!

Also, if this sounds like a good idea. I'm more than happy to take this up If someone whos been working on the project can spare sometime and explain the structure and mentor me through the process (maybe over a short call), I'll make this document and make a PR.

References

• https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
• https://github.com/rust-analyzer/rust-analyzer/blob/d7c99931d05e3723d878bea5dc26766791fa4e69/docs/dev/architecture.md
• https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md
• https://caddyserver.com/docs/architecture