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.

Sign up for GitHub

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

Update the content detail and unbold text #341

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Update the content detail and unbold text #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d106f07
fix the title
fanyarachel Sep 23, 2024
1a104f1
Unbold the text under toggle list
fanyarachel Sep 26, 2024
3f7472d
Merge branch 'isabellewei/canvas' into isabellewei/canvas
fanyarachel Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/ToggleElement.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const anchorHash = anchor.replace(/\s+/g, "-")
border-radius: 27px;
border: 1px solid #dadada;
overflow: hidden;
font-weight: 600;
font-weight: 400;
padding-left: 0.3rem;
@apply text-black dark:text-white-800 border-primary dark:border-dark-primary;
}
Expand Down
15 changes: 8 additions & 7 deletions src/content/docs/en/developers/guides/canvas-badge-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Canvas is an open onchain profile database of user identities and achievements (

### Badge

**Badges** are attestations of identities, achievements and traits verified through the [Ethereum Attestation Service](https://docs.attest.sh/docs/welcome), issued **permissionlessly by different ecosystem projects**. Badges are wallet-bound and non-transferable. **Badges facilitate interactions between ecosystem projects and users.**
**Badges** are attestations of identities, achievements and traits verified through the [Ethereum Attestation Service](https://scroll.easscan.org/learn/scroll), issued **permissionlessly by different ecosystem projects**. Badges are wallet-bound and non-transferable. **Badges facilitate interactions between ecosystem projects and users**.

Developers can issue badges in three methods:

Expand All @@ -48,7 +48,7 @@ Developers can design badges in two ways:
Badge issuance and deployment of the contract is fully permissionless. Please follow the steps below to issue a Badge for your project.

<Aside type="note" title="Join Developer Support Channel">
For Canvas and badge questions, please join [Scroll dev support channel](https://discord.com/channels/853955156100907018/1028102371894624337)
For Canvas and badge questions, please join [Scroll dev support channel](https://discord.com/invite/scroll)
</Aside>

## Step 1 `Design`: Badge Design Guidelines
Expand All @@ -72,7 +72,7 @@ For Canvas and badge questions, please join [Scroll dev support channel](https:/
| Description | Brief description of the *purpose* of this badge and *who is eligible* |
| Structure | *One single attribute*<br/> *Multiple Badges with levels* trigged by different actions and traits |
| Category | *Achievement*: tasks you have done. e.g. Scroll Origin NFTs, tasks completion badge <br/> *Identities*: who you are. e.g. Ethereum year, GItcoin passport, NFT community badge |
| Issuance method | *Fully permissionless*: meaning your badge can be automatically issued by checking smart contract conditions <br/> *Gifted:* Badges can also be issues with no user interaction <br/> **Backend-authorized**: requires APIs to enable eligibility criteria ([API requirements](https://www.notion.so/Badge-APIs-95890d7ca14944e2a6d34835ceb6b914?pvs=21)) |
| Issuance method | *Fully permissionless*: meaning your badge can be automatically issued by checking smart contract conditions <br/> *Gifted*: Badges can also be issues with no user interaction, requires APIs <br/> *Backend-authorized*: requires APIs to enable eligibility criteria |
| Support link | **Support channel link** to your Discord/Telegram group |

<Aside>
Expand Down Expand Up @@ -146,8 +146,6 @@ Since **badges are permissionless**, Scroll Foundation may not troubleshoot indi
// http code is not 200
```
</ToggleElement>

More details: [Badge APIs] {/* TODO: where to put this extra page */}

4. **Access Readiness**: Ensure badge contract address implements `defaultTokenURI`, allowing retrieval of default display data (`name, image, description`) via `bytes32(0)` with informative name and description.
5. **Set up support**: Prepare a channel for your badge holders can find you for support, get the url to join that channel ready.
Expand Down Expand Up @@ -193,15 +191,18 @@ Regularly monitor server logs to stay informed of any potential issues, especial
<aside>
📖

[**Scroll Canvas - A**nthropomorphic "assistants" **Integration Guide for Developers**](https://www.notion.so/Scroll-Canvas-Anthropomorphic-assistants-Integration-Guide-for-Developers-2712f7a91af042c0a2d145af804bab51?pvs=21)
[**Scroll Canvas - A**nthropomorphic "assistants" **Integration Guide for Developers**](https://github.com/scroll-tech/frontends/blob/mainnet/docs/canvas.md)

</aside>

2. Share on social media about your badge launch and the eligibility criteria. Use `#BadgeonScroll` and tag `@Scroll_ZKP` to boost more visibility.
3. Monitor your community / support channel for user feedback. If there is any Canvas backend related issues, please reach out to Scroll Discord channel.

---

<ToggleElement anchor="reference-cors">
<div slot="title">Get listed on [Canvas & Badges] (https://scroll.io/canvas-and-badges)</div>

<div slot="title">Get listed on [Canvas & Badges](https://scroll.io/canvas-and-badges)</div>

<Aside>
You can display **all of the badges** in your own product permissionlessly. Discover Badges page serves as an additional discovery channel for your badges.
Expand Down