-
Notifications
You must be signed in to change notification settings - Fork 28
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
feat: refactor ICQ module documentation [NTRN-349] #219
Draft
sotnikov-s
wants to merge
14
commits into
main
Choose a base branch
from
feat/refactor-icq-module-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
joldie777
requested changes
Aug 20, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix conflicts please
…refactor-icq-module-documentation
…refactor-icq-module-documentation
… ICQ results removal, RPC node configuration)
…vate rpc node config guidelines
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.
task
https://hadronlabs.atlassian.net/browse/NTRN-349
this PR
Redesigns the
interchainqueries
module documentation by applying the docs design technique described here https://docs.divio.com/documentation-system:Overview
section by giving only a high level definition to the reader and by moving several topics from theOverview
section toExplanation
,How To
andKnown bugs
sections;Explanation
section that contains detailed description of various concepts and design decisions of the module;How To
section that contains step-by-step instructions on typical user actions;API
section that describes the module's interface;Known bugs
section that lists currently known issues and possible workarounds related to the module;related PRs
notes
How To
andExplanation
sections;How To
section is very unpolished, yet. More info about the work required to be done on that sections is in thebefore the merge
section of the PR description;left to be done
How to register a TX-typed Interchain Query with custom keys
instruction in theHow To
section;How To
section instructions, and add integration tests for these contracts. This would 1) make us assured of the code snippets from theHow To
section, because the code will be taken from a real contract, not from the top of our heads; 2) make us assured that the contract and the instructions work in time; 3) highlight by failing tests any changes required to be done in the docs regarding the instructions.before the merge