RxJS does not include top level "index" functions

[forivall]

Documentation style bug

Summary

The RxJS docs are missing the top level "index" functions.

Actual style

Only ajax, fetch, operators, testing and webSocket sections are included.

Expected style

"index" section is included in official docs, in addition to the above sections.

[aditya-7562]

Thank you for reporting this issue, @forivall .

After investigating the RxJS doc structure, I believe the root cause lies in the current DevDocs scraper setup:

1. Scraper Skipping /api/index:
   The rxjs.rb scraper currently has the pattern /api/index/ listed in options[:skip_patterns], which prevents any of the top-level functions (like of, from, interval, etc.) from being fetched or processed. I plan to remove this from the skip list and explicitly include generated/docs/api/index.json (or its children) in the initial_urls to ensure these entries are scraped.

2. Sidebar Grouping in entries.rb:
   Even after scraping, functions from /api/index/function/... wouldn't be labelled or grouped properly in the sidebar. In the RxJS-specific entries.rb filter, I'll enhance:

   • get_name to append () to function names even if .api-type-label.function is missing (which is the case for many index functions).
   • get_type to classify these under a new "Top-level Functions" section for better sidebar clarity.

Once the scraper and filter are updated, functions such as of(), from(), etc., will appear and be searchable in the DevDocs RxJS documentation.

Let me know if you're open to a PR addressing this!

[simon04]

Closing, see discussion in #2540.

[forivall]

I'd need to do some analysis to verify, but i think everything in operators is also in index - so, the solution could either drop a separate operators section and include only the index, or dedupe and remove the items which are in operators from the index section. Either way, this would be an improvement, because as it stands, things like asyncScheduler and of and from are not available on DevDocs.