8000 [WIP] Split console component documentation by wouterj · Pull Request #5156 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

[WIP] Split console component documentation #5156

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

Closed
wants to merge 3 commits into from

Conversation

wouterj
Copy link
Member
@wouterj wouterj commented Apr 7, 2015
Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets POC for #5104 and #4100

The usage of the Console component is now duplicated in cookbook and components. But the cookbook links to the components docs for some things. This lead to much confusion (I've seen quite a few people that created an application.php file just to add a command to a bundle).

The new article purely focusses on the usage part, meaning that it can be used for both framework and standalone usage. The cookbook will then focus on some framework special cases (e.g. ContainerAwareCommand) and the components on standalone things (e.g. installation, setting up console applications (#4997), etc.).

Todo

  • Finish rewrite (left the action somewhere through the middle)
  • Remove cookbook duplication
  • Reread things to see if it's still a smooth experience

It doesn't make sense to tell about window's coloring support before
talking about the features of the component. It's relevant only for the
coloring stuff (as other ANSI things are supported by windows).
It makes more sense to have it in another article, so it can be referenced
better by other doc articles (like the cookbook) and other sites.
@weaverryan
Copy link
Member

ping @wouterj. I do like this general idea - we have one topic split up into too many places.

@wouterj
Copy link
Member Author
wouterj commented Aug 13, 2016

Closing, the restructuring did most of the things done in this PR.

@wouterj wouterj closed this Aug 13, 2016
@wouterj wouterj deleted the console_split branch August 13, 2016 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0