Define the Repository Structure

[gilkeidar]

We need to define how our repository should look like for maximum clarity.

What I mean by this is deciding the directory structure; I suggest the following one:

• .github
  • workflows
  • All CI/CD or other GitHub Actions workflows go here
• dist
  • Distribution folder - this is where the code to be deployed goes (i.e., all minimized code)
• docs
  • Project documentation goes here (home for JSDocs generated docs, though if we want to handwrite some of our documentation here, we can put the JSDocs documentation another level done, e.g. in docs/codebase or something)
• src
  • This is where all of our project code should go - HTML, CSS, JavaScript files, etc. Of course, there should be a subtree of directories here as appropriate (E.g., src/miniapps could include directories cartomancy, molybdomancy, etc.)
• tests
  • This is where all unit / E2E tests should go
  • Advantage - all tests are in one place, doesn't clutter src directory
  • Disadvantage - need to search for relevant src / test files when writing tests

What do you think?

[gilkeidar]

The repository structure has been approved.