Skip to content
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 6 commits into from
Oct 7, 2024
Merged

docs: apply formatting updates #14

merged 6 commits into from
Oct 7, 2024

Conversation

sudikshyapant
Copy link
Contributor

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
  • Update to Existing Document
  • Bug Fix
  • Question/clarification
  • Other (please describe):

Related Issues

Fixes #[issue number related to documentation update, if any]


Checklist

  • I have reviewed the existing documentation to avoid duplication.
  • The new or updated document includes clear and concise information.
  • All relevant sections (e.g., introduction, usage examples, references)
    are included.
  • The document follows the project's style guide and formatting rules.
  • I have included any necessary references or external resources.
  • Spellcheck and grammar check have been performed.
  • (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.

# 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.
@sudikshyapant sudikshyapant self-assigned this Oct 7, 2024
john-light
john-light previously approved these changes Oct 7, 2024
Copy link
Contributor

@john-light john-light left a 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.

docs/technical/bitcoin-bridge.md Outdated Show resolved Hide resolved
Co-authored-by: Jose Storopoli <jose@storopoli.io>
@storopoli storopoli merged commit 17049b3 into main Oct 7, 2024
3 checks passed
@storopoli storopoli deleted the bitcoin_bride_review branch October 7, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants