Skip to content

docs: update jsdoc for UserConfigSchema.title with example#3770

Merged
delucis merged 3 commits intowithastro:mainfrom
gameroman:main
Mar 23, 2026
Merged

docs: update jsdoc for UserConfigSchema.title with example#3770
delucis merged 3 commits intowithastro:mainfrom
gameroman:main

Conversation

@gameroman
Copy link
Copy Markdown
Contributor

Description

Updated jsdoc for UserConfigSchema.title with example

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 22, 2026

🦋 Changeset detected

Latest commit: 9d40e19

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 22, 2026

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 9d40e19
🔍 Latest deploy log https://app.netlify.com/projects/astro-starlight/deploys/69c14f12cd509c0008b98453
😎 Deploy Preview https://deploy-preview-3770--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added the 🌟 core Changes to Starlight’s main package label Mar 22, 2026
@astrobot-houston
Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any issues you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks @gameroman! As this is a change to our core package, we should add a changeset to trigger a release. You can do that locally by running pnpm changeset add or click the link in the changeset bot comment in this PR.

Let me know if you need any guidance!

@delucis delucis added the 🌟 patch Change that triggers a patch release label Mar 23, 2026
Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Perfect — thank you @gameroman 🙌

I tweaked the change description slightly to be more user-facing (e.g. UserConfigSchema is kind of an internal naming detail, so the change instead talks about “Starlight configuration” which is probably what a user might understand).

@delucis delucis merged commit 6e7bed1 into withastro:main Mar 23, 2026
16 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Mar 23, 2026
gxxxr-111 pushed a commit to gxxxr-111/starlight that referenced this pull request Apr 9, 2026
dadezzz pushed a commit to dadezzz/university_notes that referenced this pull request Apr 11, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [@astrojs/starlight](https://starlight.astro.build) ([source](https://github.com/withastro/starlight/tree/HEAD/packages/starlight)) | [`0.38.2` → `0.38.3`](https://renovatebot.com/diffs/npm/@astrojs%2fstarlight/0.38.2/0.38.3) | ![age](https://developer.mend.io/api/mc/badges/age/npm/@astrojs%2fstarlight/0.38.3?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@astrojs%2fstarlight/0.38.2/0.38.3?slim=true) |

---

### Release Notes

<details>
<summary>withastro/starlight (@&#8203;astrojs/starlight)</summary>

### [`v0.38.3`](https://github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0383)

[Compare Source](https://github.com/withastro/starlight/compare/@astrojs/[email protected]...@astrojs/[email protected])

##### Patch Changes

- [#&#8203;3799](withastro/starlight#3799) [`313611b`](withastro/starlight@313611b) Thanks [@&#8203;JosefJezek](https://github.com/JosefJezek)! - Improves Czech UI translations

- [#&#8203;3770](withastro/starlight#3770) [`6e7bed1`](withastro/starlight@6e7bed1) Thanks [@&#8203;gameroman](https://github.com/gameroman)! - Adds examples to the inline documentation for `title` in the Starlight configuration object

- [#&#8203;3801](withastro/starlight#3801) [`fedd48b`](withastro/starlight@fedd48b) Thanks [@&#8203;delucis](https://github.com/delucis)! - Fixes missing draft content warning in dev on pages using the hero layout

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xMDQuOCIsInVwZGF0ZWRJblZlciI6IjQzLjEwNC44IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: Renovate Bot <[email protected]>
Co-committed-by: Renovate Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🌟 core Changes to Starlight’s main package 🌟 patch Change that triggers a patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants