-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs: apply formatting updates #14
Merged
Merged
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
# Documentation Pull Request Template ## Description This pull request updates the Bitcoin bridge documentation to improve clarity, accuracy, and completeness. The main changes are: 1. Update time-lock to 1 week based on current DRT implementation 2. Add information on current operator fee and mining fees 3. Ensure proper nesting in points of deposit process 4. Minor improvements to the withdrawal process description for better clarity. These updates aim to provide more accurate and up-to-date information about the Bitcoin bridge operations, enhancing user understanding and reducing potential misinterpretations. --- ## Type of Change - [ ] New Document - [x] Update to Existing Document - [ ] Bug Fix - [ ] Question/clarification - [ ] Other (please describe): --- ## Related Issues Fixes #[issue number related to documentation update, if any] --- ## Checklist - [x] I have reviewed the existing documentation to avoid duplication. - [x] The new or updated document includes clear and concise information. - [ ] All relevant sections (e.g., introduction, usage examples, references) are included. - [x] The document follows the project's style guide and formatting rules. - [ ] I have included any necessary references or external resources. - [x] Spellcheck and grammar check have been performed. - [x] (For updates) I have verified that the changes reflect the current state of the project. --- ## Additional Information The updates to the time-lock period and fee information reflect the current implementation of the Bitcoin bridge. The restructuring of certain sections aims to improve readability and reduce potential misunderstandings. --- ## Reviewer Checklist - [ ] The purpose and scope of the document are clear. - [ ] The document is easy to understand and follow. - [ ] There are no typos or grammatical errors. - [ ] All necessary sections are included and well-structured. - [ ] The document is consistent with the project's style guide. - [ ] Any referenced links or resources are valid and appropriate.
john-light
reviewed
Oct 7, 2024
john-light
reviewed
Oct 7, 2024
john-light
previously approved these changes
Oct 7, 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.
Pushed some fixes. Content is good now.
Regarding the list numbering, it is intentional to use 1.
at the beginning of each list item, it makes editing and reviewing list updates easier. See style guide section on lists.
storopoli
requested changes
Oct 7, 2024
Co-authored-by: Jose Storopoli <[email protected]>
storopoli
approved these changes
Oct 7, 2024
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.
Documentation Pull Request Template
Description
This pull request updates the Bitcoin bridge documentation to improve clarity, accuracy, and completeness. The main changes are:
These updates aim to provide more accurate and up-to-date information about the Bitcoin bridge operations, enhancing user understanding and reducing potential misinterpretations.
Type of Change
Related Issues
Fixes #[issue number related to documentation update, if any]
Checklist
are included.
of the project.
Additional Information
The updates to the time-lock period and fee information reflect the current implementation of the Bitcoin bridge. The restructuring of certain sections aims to improve readability and reduce potential misunderstandings.
Reviewer Checklist