Skip to content

Commit

Permalink
Merge branch 'master' into tutorial_for_multichain_dao_contract
Browse files Browse the repository at this point in the history
  • Loading branch information
bucanero authored Nov 27, 2024
2 parents fe855fc + 51e1b01 commit d653d9f
Show file tree
Hide file tree
Showing 44 changed files with 595 additions and 420 deletions.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://stackoverflow.com/questions/tagged/nearprotocol
about: Please ask and answer questions here.
- name: Need help?
url: https://t.me/neardev
about: Get technical support from our developer community on Telegram.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: 🐞 Report a Documentation Error
description: Report errors or unclear content in the documentation
title: "[BUG] "
labels: ["documentation", "bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help us improve our documentation! 🙏
- type: textarea
id: description
attributes:
label: Description
placeholder: The documentation is incorrect/unclear/missing information about...
validations:
required: true

- type: input
id: page-url
attributes:
label: Page URL
placeholder: https://docs.near.org/<path>
validations:
required: true

- type: checkboxes
id: impact
attributes:
label: Impact
description: How does this documentation issue affect users?
options:
- label: Incorrect information
- label: Missing information
- label: Unclear explanation
- label: Broken link
- label: Code example doesn't work
- label: Other (please specify in description)
validations:
required: true

- type: textarea
id: suggested-fix
attributes:
label: Suggested Fix
placeholder: I suggest changing/adding...
validations:
required: false
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: 📝 Documentation Request
description: Request new documentation or updates to existing docs
title: "[DOC] "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: "## 📝 Documentation Request"

- type: dropdown
id: doc_type
attributes:
label: "Documentation Type"
options:
- "New Documentation"
- "Update Existing Documentation"
validations:
required: true

- type: textarea
id: what
attributes:
label: "What needs documentation?"
placeholder: "Describe what needs to be documented or updated and WHY is it needed."
validations:
required: true

- type: textarea
id: done
attributes:
label: "Acceptance Criteria"
placeholder: "What exactly needs to be done before this issue can be closed? (e.g., code examples, diagrams, step-by-step guides)"
validations:
required: true

- type: textarea
id: additional
attributes:
label: "Resources & References"
placeholder: "Any relevant resources, existing documentation, code references, or screenshots?"

- type: dropdown
id: priority
attributes:
label: "Priority"
options:
- "🔴 P0 : Missing Critical Documentation"
- "🟠 P1 : Important Documentation Gap"
- "🟡 P2 : Documentation Enhancement"
- "🟢 P3 : Nice to Have"
- "⚪ P4 : Minor Update"
validations:
required: true

- type: markdown
attributes:
value: |
| Priority | Name | Description |
|----------|------|-------------|
| 🔴 P0 | CRITICAL | Missing documentation blocking team progress |
| 🟠 P1 | HIGH | Important documentation gap affecting productivity |
| 🟡 P2 | MEDIUM | Significant documentation enhancement |
| 🟢 P3 | NORMAL | Helpful documentation addition |
| ⚪ P4 | LOW | Minor documentation update |
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/documentation-request.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/meta-improvement.md

This file was deleted.

72 changes: 0 additions & 72 deletions .github/workflows/build-docs.yml

This file was deleted.

4 changes: 2 additions & 2 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ For each language, the current plan is to translate all the documents with the f
**Developer**

1. `concepts`
2. `develop`
2. `build`
3. `tutorials`
4. `tools`
5. `api`
6. `intergrator`
6. `integrations`


**Exchanges & Integration**
Expand Down
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Check out the following links

## Contributing

NEAR uses [Docusaurus](https://docusaurus.io) for documentation. Please refer to their documentation for details on major structural contributions to the documentation.
NEAR uses [Docusaurus](https://docusaurus.io) for documentation. Please refer to their documentation for details on major structural contributions to the documentation.

For simple content changes you have 2 options

Expand Down Expand Up @@ -112,13 +112,7 @@ If you found a broken link from a Google search, please request to remove it fro
## Check for broken links
Before opening a pull request, please check for broken links:
```bash
yarn test
```
or id you are in the `./website` directory:
Before opening a pull request, please check for broken links by navigating to `./website` directory and run:
```bash
yarn full-test
Expand Down
8 changes: 4 additions & 4 deletions blog/2024-05-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ hide_table_of_contents: true
---


*Chain signatures enable you to implement multichain and cross-chain workflows in a simple way. Lets take a look at a few possible use cases*
*Chain signatures enable you to implement multichain and cross-chain workflows in a simple way. Let's take a look at a few possible use cases*

<!-- truncate -->


## Trade Blockchain assets without transactions

Trading assets across different blockchains usually require using a bridge that supports them, bringing longer settlement times as the trades are not atomic and require confirmation on both blockchains.
Trading assets across different blockchains usually requires using a bridge that supports them, bringing longer settlement times as the trades are not atomic and require confirmation on both blockchains.

Using Chain signatures, you can trade assets across chains simply swapping the ownership of NEAR accounts that control funds on different blockchains. For example, you could trade a NEAR account that controls a Bitcoin account with `X BTC` for another NEAR account that controls an Ethereum account with `Y ETH`.

Expand Down Expand Up @@ -63,7 +63,7 @@ An attractive way of managing Web3 accounts is to use existing Web2 accounts to

1. Deploy a NEAR contract that allows the bearer of a user's [JWT token](https://jwt.io/) to sign a blockchain transaction (Ethereum, Polygon, Avalanche, and others)
2. The user validates their identity with a third-party receiving a JWT Token
3. The user holding that token can interact with blockchain applications on Ethereum/Polygon/+++ via the NEAR contract for the duration of it's validity
3. The user holding that token can interact with blockchain applications on Ethereum/Polygon/+++ via the NEAR contract for the duration of its validity

Any method of controlling a NEAR account can also be used to control a cross-chain account.

Expand All @@ -86,7 +86,7 @@ A generic Keypom user-flow could be:
5. The user returns the remaining funds to the developer and their account is unlocked

:::tip
This allows easy on-boarding to decentralized apps. The accounts are initially restricted to prevent the user being able to simply withdraw the `NEAR` from the account.
This allows easy onboarding to decentralized apps. The accounts are initially restricted to prevent the user being able to simply withdraw the `NEAR` from the account.
:::

## DeFi on Bitcoin (and other non-smart contract chains).
Expand Down
Loading

0 comments on commit d653d9f

Please sign in to comment.