more intuitive project structure

[srele96]

example:

// paths
sk-experiments
sk-experiments/experiments
sk-experiments/experiments/experiment-A
sk-experiments/experiments/experiment-B
sk-experiments/experiments/experiment-C
sk-experiments/experiments/README.md
sk-experiments/README.md

• Hide index page configuration
• Make index page more presentable
• Index page shows title and short description of each experiment

[srele96]

Goal - A more intuitive project structure.

• How do I structure the project?
• What types of projects did I do?
• What types do my directories have?
• Only readme files:
  • A story.
  • A reference to external directory.
  • A story may be related to a programming language or not
  • I could place readme-only stories to directory closes to used language (Does it semantically make sense?)
• Should I diferentiate stories?
  • JavaScript
  • Python
  • etc...
• What if i attempt to get familiar with new algorithm or data structure?
  • Should algorithms have a dedicated directory?
• Experiment:
  • Has source code.
  • Has one or more readme files.
• I may use different programming languages:
  • Python
  • CPP
  • JS
  • etc...
• Should TypeScript and JavaScript be in the same directory?
  • If no - Why?
  • If yes - Why?
• What if I use multiple languages?
  • Should I just split them, even though they are grouped?

What about:

sk-experiments/

sk-experiments/javascript/
sk-experiments/javascript/experiment-A/
sk-experiments/javascript/experiment-A/README.md
sk-experiments/javascript/experiment-B/
sk-experiments/javascript/experiment-B/README.md
sk-experiments/javascript/README.md

sk-experiments/python/
sk-experiments/python/experiment-A/
sk-experiments/python/experiment-A/README.md
sk-experiments/python/README.md

sk-experiments/cpp/
sk-experiments/cpp/experiment-A/
sk-experiments/cpp/experiment-A/README.md
sk-experiments/cpp/README.md

sk-experiments/README.md

[srele96]

Multi-Language git project, formatter problem.

If i use JS, CPP, Python, and other languages, what about formatting configuration?

Current formatting configuration calls prettier --write . which formats everything that isn't in prettierignore.

I can set up formatter after a language directory grows big.

• Why did I want monorepo?
• Why did I want all projects in one repository?

I wanted to reuse:

• prettier configuration (config, ignore, package, etc...)
• i considered project-wide eslint
• pre-commit hooks
• .editorconfig
• .gitignore
• base project setup (it always took some time to setup new repository)

Options:

• Continuous Integration formatter checks.

The current problem is project architecture.

[srele96]

Related consider not using monorepo.