Skip to content

Conversation

aditya-7562
Copy link

Fixes #2529

This PR enhances the RxJS documentation by introducing a dedicated Top-level Functions category in the DevDocs sidebar. This improves discoverability for core RxJS functions such as of(), from(), and merge(), which were previously uncategorized or grouped under "Miscellaneous".

✅ Changes Made:

  • Updated lib::docs::filters::rxjs::entriesget_type to return Top-level Functions for root-level api/ entries that don't belong to any operator class (e.g., ajax, animationFrameScheduler, etc.).

  • Sidebar now reflects the new grouping for standalone functional APIs.

  • Ensured no impact to existing guide sections or categorized operators.

🧪 Testing

  • Ran the scraper locally and verified a successful build

  • Confirmed sidebar now contains a Top-level Functions section

  • Verified visual consistency and link correctness across updated entries

@aditya-7562 aditya-7562 requested a review from a team as a code owner July 17, 2025 09:04
@simon04
Copy link
Contributor

simon04 commented Jul 21, 2025

timeInterval appears twice now as http://localhost:9292/rxjs/api/operators/timeinterval and http://localhost:9292/rxjs/api/index/function/timeinterval. Is this intended?

@aditya-7562
Copy link
Author

timeInterval appears twice now as http://localhost:9292/rxjs/api/operators/timeinterval and http://localhost:9292/rxjs/api/index/function/timeinterval. Is this intended?

Thanks for catching that!

Yeah, the duplication is actually intentional — it matches how the official RxJS docs list timeInterval in both the standalone functions and the operators section. Since it’s validly part of both, the scraper now reflects that to stay consistent with the source.

That said, if you think we should clean it up or consolidate one of the paths in DevDocs, I’m happy to make the change!

@aditya-7562
Copy link
Author

Hey @simon04 Just checking in on this PR.

As you pointed out, timeInterval shows up in both the operators and top-level functions sections — that’s actually intentional to match the official RxJS docs, which list it in both places. The idea was to stay consistent with that structure, but I’m totally open to changing it if you think it makes more sense to consolidate.

Would love to hear your thoughts when you get a chance — happy to tweak things as needed!

@simon04
Copy link
Contributor

simon04 commented Jul 27, 2025

Many users of devdocs simply use the search to find symbols when they already know the library. I dislike that every function is shown twice in the results (with different typesetting) when the actual content is indistinguishable.

For comparison, searching for timeInterval on rxjs.dev only results in https://rxjs.dev/api/index/interface/TimeInterval and https://rxjs.dev/api/index/function/timeInterval

image

@aditya-7562
Copy link
Author

Thanks for the thoughtful feedback, @simon04 — that’s a really good point about the search results feeling cluttered with duplicates.

I included timeInterval in both sections to stay close to how the official docs list is, but I totally get that DevDocs has a different focus, especially when it comes to usability and search clarity.

Would you prefer we just keep it under operators/ or under index/function/? I’m happy to clean it up either way — just want to make sure it fits well with how DevDocs is organized.

Appreciate the guidance!

@simon04 simon04 closed this Jul 29, 2025
@aditya-7562 aditya-7562 deleted the fix/rxjs-scraper-index-support branch August 2, 2025 06:19
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.

RxJS does not include top level "index" functions
2 participants