-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[WIP] Making consistent component names throughout the docs #3183
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
Conversation
Hey Philipp! I agree with what you've listed here. On the components entry page, I think that "DOM Crawler" should be "DomCrawler" - I don't see these as "concepts", I see these as component names. A bit unrelated to capitalization, I'm wondering if we should remove the links on all of the top-level index items. So for example, "Dependency Injection" would change to "DependencyInjection", but we'd also remove the link. The issue is that I often see people click that top-level link only to then stare at the next index page, wondering what to do next. The first link under each component should (I think) take you to the introduction page. In areas where we do actually say "dependency injection pattern", then clearly that's a concept - so once again, I agree. But I imagine that almost every time we say "Dependency Injection" in the components docs, we're referring to the component, not the concept. I'll see if anyone else has any suggestions and look to merge this in a few days :). Cheers! |
Hi Ryan, sounds good. I'll once again page through the docs and update the "Dependency Injection" thing, especially regarding the index. I'll also update the components index page as suggested. Regarding the links on the components index page, let's wait for comments - if we remove the links I can include this later :-) |
I've updated Class Loader, CSS Selector, DOM Crawler, Dependency Injection, HTTPKernel and Options Resolver to use the real component names on the components overview page and in the index. |
👍 We can keep the index documents, but for the everyday usage it's better to link directly to the introduction chapters. |
But then, all index pages are sort of useless as nothing links to it... |
Thought about the link problem, too. What about linking the index explicitly by some |
Well, the index page is at least still useful if you want to link to an overview of a particular component/section from your own blog, etc. |
Hi guys! I've merged this in since the links idea was really unrelated to this (my fault!). I don't feel too strongly one way or another about the links - I would prefer to link to the introduction, but I agree that it sort of makes the index pages useless (though I think we may at least have some internal breadcrumbs links to them). Thanks! |
As discussed in #3173 here's a WIP PR for making the component names consistent.
What I did throughout the whole docs:
ClassLoader
> ClassLoaderWhat I did not:
Some things are tricky, however:
Please let me know if you have any suggestions.