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

Update README #141

Merged
merged 4 commits into from
Sep 11, 2024
Merged

Update README #141

merged 4 commits into from
Sep 11, 2024

Conversation

haszi
Copy link
Contributor

@haszi haszi commented Jun 23, 2024

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.

@tiffany-taylor
Copy link
Member

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 --list option, as you've done, may be sufficient. Another thought is maybe having a section that lists the different packages and formats, but displayed in a table format rather than as shell output. I'll do some more thinking on this.

@tiffany-taylor
Copy link
Member

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.

@haszi
Copy link
Contributor Author

haszi commented Jun 29, 2024

...having a list on a web page somewhere, even if it's a little outdated has been better than none...

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.
As far as I can tell, the only formats that are in a good shape are the PHP package's XHTML-based formats and the generic XHTML format (to a certain degree). And those are the only ones we have tests for too.

TL;DR: other than a handful of XHTML-based formats, I don't think most of the formats are usable. :-)

@haszi
Copy link
Contributor Author

haszi commented Jul 28, 2024

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?

@haszi haszi requested a review from tiffany-taylor August 24, 2024 14:57
@tiffany-taylor
Copy link
Member

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. :/

@Girgias Girgias merged commit 8e2da87 into php:master Sep 11, 2024
9 checks passed
@Girgias
Copy link
Member

Girgias commented Sep 11, 2024

Merging as we can always decided later if we should remove the options that don't work.

@haszi haszi deleted the Update-README branch September 11, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants