Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/improve config no_auto_register_paths docs #285

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

cllns
Copy link
Member

@cllns cllns commented Mar 7, 2025

Will extend to 2.0 and 2.1 once this review gets approved.

cllns added 2 commits March 7, 2025 13:36

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
I wrote it the other way to prioritize which are core Hanami concepts,
but I think it's better to be accurate
Note that the default value for `no_auto_register_paths` is `["db", "entities", "relations", "structs"]`,
so you do not need to specify those. Also, be sure to append to that list.

These apply for the root of the application, as well within any slices.
Copy link
Member

@timriley timriley Mar 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should link to the "slices" guide here. If a reader is going through the docs in rough order of appearance, they won't have got to slices yet.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, added!

This makes me think we should consider re-ordering the guides, as well (perhaps on the new site). The current order is: Booting, Container and components, Providers, Settings, Autoloading, Environments, App config, Inflector, Code reloading, Slices.

Slices are more core than code reloading, or the inflector IMO. I think Autoloading and Environments could be lower as well. Perhaps: Booting, Container and components, Providers, Settings, App config, Slices, Autoloading, Environments, Inflector, Code reloading?

I still think linking to Slices is a good idea regardless of the order.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cllns :) Agree that it'd be worth trying a different order. We came up with this order years ago for 2.0 and haven't reconsidered it since. I think an "Overview" page for the App guide would be useful thing to have too. That way we can introduce all the key concepts in relation to each other, and provide relevant jumping off links to learn more.

Copy link
Member

@timriley timriley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks! One minor suggestion, otherwise happy to see this go in.

@cllns
Copy link
Member Author

cllns commented Mar 12, 2025

Updated the guides for 2.0 and 2.1 as well, but listing the no_auto_register_paths as just ["entities"], because that's what is true for those versions.

Copy link
Member

@timriley timriley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants