Skip to content

docs: tweak overrides reference headings prop wording#984

Merged
delucis merged 1 commit intowithastro:mainfrom
HiDeoo:hd-docs-override-reference-headings-component
Oct 26, 2023
Merged

docs: tweak overrides reference headings prop wording#984
delucis merged 1 commit intowithastro:mainfrom
HiDeoo:hd-docs-override-reference-headings-component

Conversation

@HiDeoo
Copy link
Copy Markdown
Member

@HiDeoo HiDeoo commented Oct 24, 2023

What kind of changes does this PR include?

  • Changes or translations of Starlight docs site content

Description

This pull request is a follow up to #861.

It tweaks the wording of the headings prop in the overrides reference to emphasize that the documentation is referencing building a custom table of contents component (with Starlight provided route data) and not a table of contents with custom data using the builtin component.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Oct 24, 2023

⚠️ No Changeset found

Latest commit: 82f1864

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@netlify
Copy link
Copy Markdown

netlify bot commented Oct 24, 2023

👷 Deploy Preview for astro-starlight processing.

Name Link
🔨 Latest commit 82f1864
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/6537e8f722f45f0008128b60

@github-actions github-actions bot added the 📚 docs Documentation website changes label Oct 24, 2023
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 @HiDeoo — LGTM. Let’s merge after #939 so that gets marked as needing updating.

@delucis
Copy link
Copy Markdown
Member

delucis commented Oct 26, 2023

Merged #939 so merging this one too 🙌

@delucis delucis merged commit 8ed4a2b into withastro:main Oct 26, 2023
vasfvitor added a commit to vasfvitor/astro-starlight that referenced this pull request Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 docs Documentation website changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants