feat: integration docs #642
Open
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #642 +/- ##
=======================================
Coverage 93.49% 93.49%
=======================================
Files 234 234
Lines 34939 34939
=======================================
Hits 32667 32667
Misses 2272 2272 ☔ View full report in Codecov by Sentry. |
cjcobb23
requested changes
Oct 1, 2024
| @@ -0,0 +1,89 @@ | |||
| # Axelar Amplifier Integration Guide | |||
There was a problem hiding this comment.
I'm not sure if this is the proper placement for the file. @eguajardo where should this be placed so it renders correctly in the mdbook?
There was a problem hiding this comment.
file must be inside doc/src folder and it should be referenced in the SUMMARY.md so it can be properly indexed. You can test it by running:
mdbook build doc
mdbook serve doc --open
Co-authored-by: CJ Cobb <[email protected]>
Co-authored-by: CJ Cobb <[email protected]>
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.
Description
Created draft of a unifying integration doc that ties together all the contract docs
Todos
Steps to Test
Expected Behaviour
Other Notes