docs(fix): Improve the Index API Definition content #208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have been getting feedback that we need a topic or landing page that helps users understand our different indexing APIs at a higher level. - WIP
Updating this topic and working on a better format for the long-form topics overall - WIP
Improving this topic with the goal to make all API Definition topics more standardized. I plan to move the conceptual information higher in the topic (e.g. describing objects and sections) and minimize the amount of code samples in these API topics and snippets because having so many is hard to maintain. Instead, we'll link to the API playground and proto files.
✅ Deploy Preview for luxury-shortbread-acee05 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Moving things around to improve the flow of this topic. For example, start by describing the endpoint without being too REST or gRPC specific. I also changed the API Playground and examples links to be a tip (stands out better). After going through the conceptual information (e.g. defining document and section), I provide some REST and gRPC examples. Still WIP as I might remove the examples and point to the playground and proto definitions.
pwoznic
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We need to add a topic that guides users about which indexing method to choose and why. Also, updating the topics with the goal to make all API Definition topics more standardized. Will move conceptual information higher in the topic (e.g. defining objects and sections). We need to minimize the amount of code samples in these API topics and snippets for maintenance reasons and instead link more to the API playground and proto files. - WIP