Skip to content

Conversation

@yihuiliao
Copy link
Member

@yihuiliao yihuiliao commented Jan 16, 2026

apologies for the non-descriptive title but this PR does two things

  1. adds a inline alert warning users to add a width/height for virtualizer
  2. adds the headings of each page to the tags so users can look up things like "section" and pages mentioning those will appear

✅ Pull Request Checklist:

  • Included link to corresponding React Spectrum GitHub Issue.
  • Added/updated unit tests and storybook for this change (for new code or code which already has tests).
  • Filled out test instructions.
  • Updated documentation (if it already exists for this component).
  • Looked at the Accessibility Practices for this feature - Aria Practices

📝 Test Instructions:

  1. Go to virtualizer page and check the inline alert
  2. Go to the search and type "section" and that some pages actually appear (unlike what happens in prod where nothing appears). You can try out other keywords as well!

🧢 Your Project:

@rspbot
Copy link

rspbot commented Jan 16, 2026

headings.push(...subHeadings);
}
}
let allTags = (page.exports?.tags || page.exports?.keywords as string[]) || [];
Copy link
Member

Choose a reason for hiding this comment

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

Should we include page.exports?.relatedPages.map(page => page.title) here? It might be nice to have the hook names accounted for in the docs.

If we do that we probably want to filter out .startsWith('Testing ') so the S2 component testing docs aren't included.

Copy link
Member Author

Choose a reason for hiding this comment

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

oh yeah that sounds like a good idea, let me do that

@rspbot
Copy link

rspbot commented Jan 16, 2026

@rspbot
Copy link

rspbot commented Jan 26, 2026

@yihuiliao yihuiliao added this pull request to the merge queue Jan 26, 2026
github-merge-queue bot pushed a commit that referenced this pull request Jan 26, 2026
* chore: new docs followup

* add headings to search as keywords

* fix lint

* filter tags

* add example to filter
@yihuiliao yihuiliao added the documentation Improvements or additions to documentation label Jan 26, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 26, 2026
@yihuiliao yihuiliao added this pull request to the merge queue Jan 26, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 26, 2026
@rspbot
Copy link

rspbot commented Jan 26, 2026

@devongovett devongovett merged commit 6c8fe49 into main Jan 26, 2026
28 of 30 checks passed
@devongovett devongovett deleted the docs-followup branch January 26, 2026 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants