8000 Avoiding duplicated documentation · Issue #4100 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Avoiding duplicated documentation #4100

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.

Sign up for GitHub

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

Jump to bottom
Closed
xabbuh opened this issue Aug 7, 2014 · 4 comments
Closed

Avoiding duplicated documentation #4100

xabbuh opened this issue Aug 7, 2014 · 4 comments

Comments

@xabbuh
Copy link
Member
xabbuh commented Aug 7, 2014

Especially for the Form component, we have many things documented twice (in the book and in the components part) as @weaverryan stated in #4085:

It's difficult because the form component has a significant amount of duplication, in part because we thought that we might try to make it work for both the component and framework all in one page (but I don't think that makes sense anymore). Ideally, I'd like to find a way to duplicate less.

This may not only be true for the Form component, but may also occur for other components and they should be checked accordingly. Therefore, this issue is to discuss whether or not we can overcome these duplicated descriptions and if we agree on avoiding duplication how exactly this can be achieved.
@xabbuh xabbuh mentioned this issue Aug 7, 2014
Merged
2 tasks
@wouterj
Copy link
Member
wouterj commented Aug 9, 2014

I believe we should move slowly to the concept that we tested for the past year with the Translation component: Documenting component usage in the component docs and using the book article as a quick intro to the component docs and to document framework specific things.

@javiereguiluz
Copy link
Member

This definitely seems the way to go. I recommend to close this issue because it's too generic and not actionable. Then, when the 500+100 Challenge period finishes, we can open new issues to make the transition for each component.

@wouterj
Copy link
Member
wouterj commented Dec 17, 2014

I think this a nice place to talk about this feature. The open issue list is a list of things we have to think about or have to fix. Imo, if an issue is closed it's either fixed or will never be fixed.

We don't have a clear plan on how to fix this, this is a general problem with the docs. I don't like my option, since it means you'll move a round a lot between components and book and people might get confused by other things in the components. Maybe we have to change the complete structure of the docs...

@wouterj wouterj mentioned this issue Apr 7, 2015
Closed
3 tasks
@javiereguiluz
Copy link
Member

I think we can close this issue because it's too generic. Besides, we are already committed to reduce duplication in lots of places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@javiereguiluz @weaverryan @wouterj @xabbuh
0