Skip to content

[Facelift] HttpFoundation (components/http_foundation/introduction.rst and related sections) #2395

Closed
@weaverryan

Description

@weaverryan

This ticket is about re-reading this document and giving it a facelift. No matter who you are, you have a role to play in this.

How this works:

If you read this document and find some changes, you can either comment here or (even better) create a pull request. After various people have reviewed this chapter, we'll close this issue.

What to do

Well, that depends on who you are :)

If you're newer to Symfony

Read the entry and code along with it.
a) Are there inaccuracies - code that doesn't work?
b) Are there parts that just don't understand very well?
c) Are there details that aren't explained enough?
d) Is there language that's confusing?
e) Did you fall asleep while reading it? If so, good morning! Why was it so boring?
f) Are there inconsistencies between sections?

If you know Symfony pretty darn well (or want a challenge)!

a) Are there inconsistencies between sections?
b) Do you spot anything that can be done better?
c) Are we following best practices?
d) Are there sections that are too advanced or details that should be moved into a new section to keep this readable?
e) Should some details here belong somewhere else? Like in the component documentation?
f) Are there places where we can link to other areas in the documentation to help the learner cross reference?

Metadata

Metadata

Assignees

No one assigned

    Labels

    actionableClear and specific issues ready for anyone to take them.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions