Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Updates and fixes for the documentation #44

Merged
merged 11 commits into from
Nov 27, 2018

Conversation

froschdesign
Copy link
Member

  • 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

Copy link
Contributor

@tux-rampage tux-rampage left a 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."
Copy link
Contributor

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.

Copy link
Member Author

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.)

Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

@tux-rampage tux-rampage added this to In progress in QA via automation Nov 16, 2018
QA automation moved this from In progress to Reviewer approved Nov 27, 2018
@tux-rampage tux-rampage merged commit f34c8a6 into zendframework:master Nov 27, 2018
tux-rampage added a commit that referenced this pull request Nov 27, 2018
Updates and fixes for the documentation
QA automation moved this from Reviewer approved to Done Nov 27, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
QA
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants