Skip to content

Rework example section#23

Open
strzibny wants to merge 4 commits into
serpapi:masterfrom
strzibny:new-examples
Open

Rework example section#23
strzibny wants to merge 4 commits into
serpapi:masterfrom
strzibny:new-examples

Conversation

@strzibny

@strzibny strzibny commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

This PR reworks the example section to be more direct and simple. Based on the internal discussion and part of the clean up for our integration pages (see issue 8336). If you think we should add outputs for each sample, we could do that. It's a reduction for clarity, but we can still decide to feature more later.

@strzibny
strzibny requested review from aciddjus and jvmvik June 12, 2026 10:19
@strzibny
strzibny requested review from dsojevic and trusche July 21, 2026 07:46
@trusche

trusche commented Jul 24, 2026

Copy link
Copy Markdown
Member

Thanks @strzibny, overall a good improvement, I think.

It's a bit surprising though to not lead with a plain Google example; by far our most popular engine. Immersive product is currently first in your example, that's pretty specialised and requires a prior request to fetch a token. I'd move that one way down, or even exclude it. I'd rather see more of a spread highlighting the breadth of our APIs. The old list was getting a bit long indeed, but it did have much more variety.

@strzibny

strzibny commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

The idea with skipping Google search is that it's already mentioned before in a 'quick example' so repeating it feels wrong when we have so much more to mention. Still, it's not a replacement for documentation, so we can significantly reduce the examples. I am completely fine with not including Immersive product first given the extra token. On the other hand having this more complex example can be helpful. But I think I agree with you that it shouldn't be a first example. If we would keep it, what position would you assign to it?

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.

2 participants