[Refactor]: Folder structure improvement proposal

[mukireus]

What feature would you like to see?

The current folder structure appears disorganized, with example projects and packages nested within each other. It is recommended to refactor the folder structure to provide better clarity and organization.

By restructuring the folder organization, users who only include this package in their projects will avoid downloading unused example files when executing flutter pub get. This change is expected to improve the performance of the command execution by reducing the amount of data that needs to be fetched.

See

Before	After

[ulusoyca]

Thanks for the proposal. We need the example folder separately AFAIK to be able to show this page on pub dev. Otherwise examples folder looks good. I would also like to keep widgetbook inside coffee_maker_navigator_2 since it belongs to that specific project.

Other than than wolt_state_management and wolt_di also only used in coffee_maker_navigator_2. We should include them under it imo.

[mukireus]

Package layout conventions - Examples
According to the explanation on this page, we can generate markdown files to add and redirect example project paths. For instance, the flutrlint project already includes a markdown file under the "Example" tab, which can serve this purpose.

We can re-add the Widgetbook project as you suggested.

I recommend moving the wolt_di and wolt_state_management packages to the packages folder for easier access in future projects. These packages are currently located in the root directory.

Edited: You can also check out the "example" section of the widgetbook package: Widgetbook example section on pub.dev

[mukireus]

Also you can check this PR: [DRAFT] Refactor - Clean folder structure

[ulusoyca]

@mukireus The draft PR looks good. We can merge this way. @TahaTesser what is your take?

@mukireus we will also need to update the ReadMe.

[TahaTesser]

Looks good to me. This will make the samples navigation a lot better. I wanted to do this but couldn't get around it.

[mukireus]

@ulusoyca Should we also move the wolt_modal_sheet package into the packages directory? I can open a separate PR for this, or we can pair on it together. We can close the issue if needed.

[ulusoyca]

@mukireus Thanks for the great changes, and the PR! This repo is made for Wolt Modal Sheet, the other packages are planned to be released a packages during next year in separate repos, so let's keep them under the packages folder for now. I am closing this issue. Once more, thanks for the great work.