Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: apply formatting updates (#14)
* docs: apply formatting updates # 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. * fix formatting issue * Fix formatting / typos * Fix typo * docs: fix line length format Co-authored-by: Jose Storopoli <[email protected]> * fix: lints and formatting --------- Co-authored-by: sudikshyapant <[email protected]> Co-authored-by: John Light <[email protected]> Co-authored-by: Jose Storopoli <[email protected]>
- Loading branch information