[2.x] Massively simplify sidebar footer text handling #1594
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.
This PR makes breaking simplifications to how the documentation sidebar footer text is handled and customized. Instead of allowing
falseto disable it,trueto use the default text, or a string to have custom text, this removes support fortrue,falsestill works, but the default text is moved to the default option based on the Blade from the view.A drawback (and BC break) of this is that it no longer resolves dynamic links, but given the increased visibility of the option I think the tradeoff is worth it as it makes it easier to customize. It also means that the HTML is changed from dynamically using the site's configured link formatting options to hardcode a
../, resulting in<a href="../">Back to home page</a>.This will work for most sites, but projects where the docs directory is customized will need to update the link if they wish to retain the home link.
This is otherwise a great candidate to use #1590 for.