Move intro_text directly after description in config/scribe.php for easier discovery#1001
Merged
Merged
Conversation
Contributor
|
I think it was there before, but I moved it because it was one of the larger items in the config file and I didn't want to overwhelm users out of the box. Your argument makes sense though. Thanks. |
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.
When you publish the default Scribe config, the intro_text option is located much further down the file—well after many unrelated settings. However, in the generated documentation this text appears immediately beneath the API description.
This separation makes the setting surprisingly hard to find for new users who naturally look for it near description.
Why it matters
Discoverability – Users tweaking the intro usually open the file, spot description, and expect the next few lines to let them customise the introduction itself.
Logical grouping – Both fields control the top-of-page content. Grouping them keeps the mental model consistent.
Developer ergonomics – Less scrolling/searching speeds up onboarding and day-to-day config edits.