Skip to content
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

docs: splitted index #2260

Draft
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Draft

Conversation

Nayte91
Copy link

@Nayte91 Nayte91 commented Oct 11, 2024

Q A
Bug fix? no
New feature? no
Issues no
License MIT

Hello, Draft of some documentation's improvements (WIP):

  1. Splitted "Form" chapter into new page. --> This one is pretty straightforward, goal is just to shrink the index size with a quick win; Form is a big and quite stand alone chapter.
  2. Splitted "Communication Between Components: Emitting Events" and "Nested Components" in to a new "Communication between components" page. --> The goal is to regroup parts about how components can interact with each others. "Communication between components" can be renamed, but seems good.
  3. Moved the orphan's "Dispatching Browser/JavaScript Events" into the "Working with the Component in JavaScript". --> It was after the moved "Communication" chapter, so it ended up alone. It belongs in either the "Working with the Component in JavaScript", or "Advanced functionality" part.

More to come in next commits:

  • pass the tests,
  • more splits if needed,
  • look at twig/live component's splits,
  • a chapter about emitting event in PHP, instead of going out in JS/going in in PHP,
  • modify the angle of the documentation from "exhaustive list of how it works" to "how to do THIS or THAT",
  • more examples, notes and warnings blocks in doc,

Comments are welcome!

@carsonbot carsonbot added the Status: Needs Review Needs to be reviewed label Oct 11, 2024
@Nayte91 Nayte91 force-pushed the docs/live-components branch 2 times, most recently from 8015283 to 190d051 Compare October 11, 2024 20:48
@Nayte91 Nayte91 marked this pull request as draft October 12, 2024 10:21
@javiereguiluz
Copy link
Member

I'm not judging this proposal, but as a general rule: most Symfony Docs readers strongly dislike having to switch between multiple articles to fully learn something. They overwhelmingly prefer a single, comprehensive article that contains all the information, even if it's long.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review Needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants