Skip to content

Move intro_text directly after description in config/scribe.php for easier discovery#1001

Merged
shalvah merged 1 commit into
knuckleswtf:v5from
dazza-dev:improvements
Jun 30, 2025
Merged

Move intro_text directly after description in config/scribe.php for easier discovery#1001
shalvah merged 1 commit into
knuckleswtf:v5from
dazza-dev:improvements

Conversation

@dazza-dev

@dazza-dev dazza-dev commented Jun 27, 2025

Copy link
Copy Markdown
Contributor

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.

@shalvah
shalvah merged commit dd37fe9 into knuckleswtf:v5 Jun 30, 2025
5 of 6 checks passed
@shalvah

shalvah commented Jun 30, 2025

Copy link
Copy Markdown
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.

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.

2 participants