Skip to content

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Aug 21, 2025

Fix #137

@bparks13
Copy link
Member

bparks13 commented Aug 21, 2025

@cjsha Just to confirm, this PR is only removing the pages from the search, whereas the original issue is trying to keep the pages from being generated at all. If this PR marks that issue as resolved, then we would still have the pages being generated and rendered if someone types the name into the link (why they would ever do that I don't know). If we want to keep #137 as an open issue we can unlink it from this PR and merge this, since it is a good fix to remove them from search to reduce visibility.

Edit:

Ignore everything I said, I see that you created a new issue doing exactly what I said!

Copy link
Member

@bparks13 bparks13 left a comment

Choose a reason for hiding this comment

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

I'm going to approve this as it does what is purporting to do, which is hide the pages with no properties from the search (specifically, this works for DeviceNameConverter).

However, during testing I noticed some strange behavior with the search algorithm, which may or may not be controllable by us directly.

If I type "context t", I can see the ContextTask pop up:
image

However, if I type "contextt" (no space), no results appear:
image

We explicitly add the ContextTask to the TOC, under DataElements, so therefore it should appear in the search. This behavior may exist for other pages, but I did not test more than this.

@cjsha
Copy link
Member Author

cjsha commented Aug 22, 2025

I made another issue #261 to prevent unnecessary pages from being generated. This one is just going to remove them from search.


the docfx search is super finnicky e.g. dotnet/docfx#10560. I think what you're seeing is that they insert a zero-width space in some places.

We should actually consider upgrading to docfx 2.78.3 which includes this PR

@cjsha cjsha merged commit 65f3bad into main Aug 22, 2025
3 checks passed
@cjsha cjsha deleted the issue-137 branch August 22, 2025 01:39
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.

Remove certain auto-generated pages from the site using the same filter for toc

2 participants