Add doc links to README - #348
Open
kreddlear wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Add Catalog help docs link and API reference links (both to the API in general and to the Catalog Types reference specifically) to a new section of README.md.
Why
For users new to Incident IO who want to use the importer, it's helpful to be able to quickly find more information on the Catalog in general and what data is generally good to sync. Users may also find it helpful to know where the API reference lives, to facilitate more in-depth troubleshooting during sync setup.
Since the importer API key also allows connection to the API directly, this update enables LLMs to find and make API calls to troubleshoot errors as needed.