Skip to content
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

Add search to pkgdown for Connect API #275

Closed
fh-mthomson opened this issue Jun 7, 2024 · 2 comments
Closed

Add search to pkgdown for Connect API #275

fh-mthomson opened this issue Jun 7, 2024 · 2 comments

Comments

@fh-mthomson
Copy link
Contributor

While trying to interact with the Connect API, I often reference:

  1. connectapi pkgdown: https://pkgs.rstudio.com/connectapi/
  2. Connect app docs: https://docs.posit.co/connect/cookbook/

Two requests to make this slightly easier to find the relevant information:

  1. Add Search functionality to the connectapi pkgdown site
  2. Add Filter to Connect docs to limit search results to ONLY the API Cookbook and/or API Reference.

Motivating example: If I want to search for a specific endpoint name, I don't always want to see user-facing docs.

Thanks for the consideration!

@toph-allen
Copy link
Collaborator

I definitely agree that adding a filter to the Connect docs to limit only to the cookbook/API ref would be useful. I'm not sure how easy that would be, but I'll add a feature request to that effect in our issues for Connect.

@toph-allen
Copy link
Collaborator

As search was added by your pkgdown update PR, I'm closing this tracking issue. Thanks!

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

No branches or pull requests

2 participants