-
Notifications
You must be signed in to change notification settings - Fork 50
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
Update README #141
Update README #141
Conversation
For the most part, I really like the changes that have been made. It's much easier to read through and make sense of what's going on, and the phrasing is akin to the other PHP docs tutorials. The only thing I'm not certain on, is the removal of the package and format options, but mentioning the |
I'm still going back and forth on having these listed. The biggest con is that they can get outdated, and it's a maintenance burden. From personal experience with needing to check the complete list of options for something and I happen to be not near a shell, having a list on a web page somewhere, even if it's a little outdated has been better than none. Similar to a manpage. I will let others weigh in, I don't want to make the decision on this. |
I feel the same way but of the 26 formats, I know there are at least 12 that are either throwing an uncaught exception or raising hundreds of notices and warnings. On top of that, at least the PDF formats are completely outdated. TL;DR: other than a handful of XHTML-based formats, I don't think most of the formats are usable. :-) |
I have added the list of supported packages and formats to the end of the README and linked to it from the appropriate parts of the output rendering options. @tiffany-taylor would something like this be okay? |
I love the look of the table, but I've been trying to reach a decision on the contents of table. Should it include all of the options, despite some of them not working? That's the question I've been mulling over, and I feel like it should only have the options that currently work. :/ |
Merging as we can always decided later if we should remove the options that don't work. |
Add references to the other parts of the documentation pipeline.
Remove section about formats.
Remove some options and reformat the remaining ones.
@tiffany-taylor Pinging you, as promised. Please take a look and let me know what you think.