-
Notifications
You must be signed in to change notification settings - Fork 29
Updates and fixes for the documentation #44
Conversation
froschdesign
commented
Nov 16, 2018
- Updates MkDocs configuration
- Fixes headline orders
- Removes old HTML index page
- Removes some PHP tags (only needed in code examples for templates)
- Removes an old note for a to-do
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Great, thanks a lot. Just noted one minor thing to fix in the diff, otherwise good to go imho.
mkdocs.yml
Outdated
@@ -20,6 +20,5 @@ pages: | |||
- "Using AoT with Expressive and zend-servicemanager": cookbook/aot-guide.md | |||
- "Migration Guide": migration.md | |||
site_name: zend-di | |||
site_description: zend-di | |||
site_description: "Automated dependency injection and instance manager." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no instance manager in v3 anymore, in favor of psr containers and ServiceManager.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description was taken from the component list which is used for the component overview on docs.zendframework.com.
Do you have an idea to renew the description? (The description in the readme file of this repository is too long.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, how about the following descriptions?
Automated dependency injection for PSR-11 containers
A less generic one but more ZF specific could be:
Automated dependency injection for ZendServicemanager
Thoughts? I guess the component list and composer.json description should be updated then as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Automated dependency injection for PSR-11 containers
👍
I guess the component list and composer.json…
Right! And also the repository description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And also the repository description.
I can't do that. Can you? Otherwise @Ocramius / @weierophinney may jump in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updates and fixes for the documentation