Docs update & guide to where code lives

[jameskerr]

Fixed some outdated docs, but mostly wanted to create some guiding principles on where code goes in our codebase going forward.

This is the text I've added to the "Codebase Walkthrough" wiki page:

Directory Structure

├── app (renderer code)
│   ├── core (generic shared code)
│   ├── features (larger app features)
│   ├── initializers (code run on startup)
│   ├── plugins (plugin code)
│   ├── routes (entry points for each url)
│   ├── state (ui state)
│   ├── window-a.tsx (window entry points)
│   └── window-b.tsx
├── electron (main process code)
└── ppl (licensed code)

Import Rule: Only import modules from "core", "state", or your own descendants.

Exceptions:

• Components in "routes" can import modules from "features".

Bibliography

https://dev.to/bytebodger/how-i-organize-react-projects-1f36

https://addyosmani.com/largescalejavascript/

https://www.pluralsight.com/guides/how-to-organize-your-react-+-redux-codebase

https://ryanlanciaux.com/blog/2017/08/20/a-feature-based-approach-to-react-development/

https://www.robinwieruch.de/react-folder-structure

[mason-fish]

This is good stuff, I'm on board! Thanks for compiling the inspirations too, it's very helpful to have several perspectives on this.

[jameskerr]

Great!