Repository navigation
How it works: state the rule before the shortcut - #13
Merged
Merged
Conversation
The first section after the badges opened with the sites/ folder and a reversed host name, before saying what the rule was. It now opens with the rule and the URL that rule produces, and a new subsection introduces sites/ as what you reach for when that URL gets long. It also showed my-app.phpforge.dev at the top and my-app--sites.phpforge .dev eight lines later, for the same project, with nothing saying why. The version examples now use the short name throughout, and the section says both URLs reach the same folder. The first URL a new user opens becomes welcome.<domain> instead of welcome--sites.<domain>, in both READMEs and the installer: the long form teaches the reversal before the reader needs it. Every URL the section prints was checked against a running stack. CI keeps asserting the long forms and now asserts the short welcome too.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The first section anyone reads after the badges opened with the
sites/folder and a host name likev2--api.phpforge.dev— path segments reversed and joined with--— before saying what the rule was.Now:
Long first is deliberate: it is what the rule actually produces, and it is what makes the next part worth reading. A new subsection — Want a shorter URL? — then carries
forge linkand thesites/tree.The half that was not reported
The section showed
my-app.phpforge.devat the top andmy-app--sites.phpforge.deveight lines later, for the same project, with nothing saying why. It read as two different systems.The version examples now use the short name throughout, and the section says plainly that both URLs reach the same folder — which is what
resolve_docroot.lua:73-79does: trysites/<path>, fall back to the full path.The first URL you open
welcome--sites.<domain>→welcome.<domain>, in both READMEs andinstall.sh. Sending someone to the long form before they have read the rule is the same mistake in miniature.Checked, not assumed
Every URL the section prints was requested against a running stack — which is how the two-spellings problem should have been caught the first time:
CI keeps every long-form assertion — the claim that both spellings work is only true while both are tested — and gains
welcomebeside them.Headings stay one-to-one across the two languages: 24 each, including the new subsection.