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: drop list.rst and code behind it #7436

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Conversation

keradus
Copy link
Member

@keradus keradus commented Nov 14, 2023

We have 2 docs for rules:

doc B is not listed anywhere, it's big and clumsy, 2 files are same purpose - index of rules that one can find what they look for and go for fixer details page if needed.

I suggest we drop doc B

# Conflicts:
#	doc/list.rst
#	src/Documentation/ListDocumentGenerator.php
@keradus keradus marked this pull request as ready for review November 14, 2023 13:16
@coveralls
Copy link

Coverage Status

coverage: 94.784% (+0.3%) from 94.488%
when pulling a0b5508 on keradus:doc_list
into 2aee1c2 on PHP-CS-Fixer:master.

@keradus keradus enabled auto-merge (squash) November 14, 2023 13:24
Copy link
Member

@Wirone Wirone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I agree, the simpler page (variant A) is enough for explaining what each rule does, and when anyone can look deeper, then can go the rule's page. I would only ask if it's possible to make some redirect from the B's URL to A's? If not then it's OK too 😉.

(not giving approval because auto-merge is enabled, and I leave an option for suggestion above)

@keradus
Copy link
Member Author

keradus commented Nov 14, 2023

redirection on repo files:

  • we could put symlink or sth, but not sure if any value in this.

redirection on website:

  • I do not know how to do this redirection technically on github pages,

yet... ref

doc B is not listed anywhere

meaning:

  • doc B is NOT linked anywhere on our official repos or on website itself. Only way to access it is to provide given URL in browser's web address field manually

@Wirone
Copy link
Member

Wirone commented Nov 14, 2023

Yeah, I got that it's not linked anywhere, I was thinking only about places outside of the docs where it could be linked. It's not a big deal if it can't be linked. In Hugo pages can have aliases so some kind of "redirector" pages are generated alongside the actual ones, I was wondering if it's possible to apply similar approach with <meta http-equiv="refresh" content="0; url=..."> here. Feel free to merge without this, it's only nice to have 🙂.

@keradus
Copy link
Member Author

keradus commented Nov 14, 2023

likely there is possibility to have it on whatever generating website nowadays (or added on top of it).
if you know how or eager to figure it out - please go ahead and propose such PRs, i will happily merge it ;)
unfortunately, out of the blue I am not familiar with it, and I think that effort would be lost time.
overall, we use veeeeery old Sphinx...

@keradus keradus merged commit 203258a into PHP-CS-Fixer:master Nov 14, 2023
21 checks passed
@keradus keradus deleted the doc_list branch November 14, 2023 16:09
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.

None yet

3 participants