Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for draft sidebar behavior #2825

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Jan 23, 2025

Description

As discussed today during the Talking & Doc'ing session in Discord, this PR adds a new section in the draft frontmatter field documentation to document sidebar behavior for drafts.

Preview

Copy link

changeset-bot bot commented Jan 23, 2025

⚠️ No Changeset found

Latest commit: 7035ab2

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

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 7035ab2
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/67925d5ad83056000829c052
😎 Deploy Preview https://deploy-preview-2825--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: 97 (🟢 up 14 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 site configuration.

@astrobot-houston
Copy link
Collaborator

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en reference/frontmatter.md Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@github-actions github-actions bot added the 📚 docs Documentation website changes label Jan 23, 2025
Comment on lines +286 to +287
Because draft pages are not included in build output, you cannot add sidebar links to draft pages in your site sidebar config using [slugs](/guides/sidebar/#internal-links).
Links to draft pages are not included in [autogenerated sidebar groups](/guides/sidebar/#autogenerated-groups).
Copy link
Member

Choose a reason for hiding this comment

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

Small suggestion for your consideration:

  • Avoids the “sidebar links […] in your sidebar config” repetition
  • Tries specifying “directories” for the second option here to clarify the relationship between page and group
Suggested change
Because draft pages are not included in build output, you cannot add sidebar links to draft pages in your site sidebar config using [slugs](/guides/sidebar/#internal-links).
Links to draft pages are not included in [autogenerated sidebar groups](/guides/sidebar/#autogenerated-groups).
Because draft pages are not included in build output, you cannot add draft pages directly to your site sidebar config using [slugs](/guides/sidebar/#internal-links).
Draft pages in directories used for [autogenerated sidebar groups](/guides/sidebar/#autogenerated-groups) are automatically excluded in production builds.

Happy for you to decide what to do with this! In general the change is definitely and improvement — thanks @HiDeoo 💜

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.

Warning about build issue for draft pages
3 participants