-
-
Notifications
You must be signed in to change notification settings - Fork 35.4k
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: display class properties and methods in search results #21885
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should mirror this for examples (#20207).
Sorry, this got lost... Is there a way to see it live? I'm trying this: |
I'm not sure how I closed this but I can integrate this into the UI. |
@mrdoob, that link is now live. |
I touched up a bit on the search ergonomics in f285cd4 which should better the search UX with this enhancement (see top comment). |
I just saw this PR. I think we should try to combine it with the code I did a few days ago, which accelerates the search by a nice factor. What do you think? The timeout code that you added wouldn't be necessary as it would be able to run in real time. |
@octopoulos, for sure, and thanks for that. |
Then I guess I'm going to merge your first commit, the one that creates the files.json, and modify it a bit too to compress the file. |
You might want to have that in a separate PR to facilitate design feedback regarding the proposed UI; don't want that to block the current improvements you made. |
Yeah, I'm going to make another PR. I guess it will be ready by tomorrow. |
Awesome. I'll close this as we're continuing in #22542. |
Related issue: #19342
Continues: #21674
Description
This pull request creates a script to auto-generate
docs/files.json
with class methods and properties enumerated. These are integrated into search results to create marcofugaro's suggested search UI and be consumed by three's Discord bot.As per marcofugaro's UI, when you search you will find both classes and their methods. Since that may clutter up results unnecessarily, I've opted to allow users to filter using modifiers.
.
filters to class methods and properties (can be used as a prefix or combined with class names)#
filters to class methods (can be used as a prefix or combined with class names)Demo: https://raw.githack.com/CodyJasonBennett/three.js/generate-docs/docs/.
Enhanced.Search.mp4