Skip to content

Commit 83d24d9

Browse files
Add new explain-cards for Artificial Intelligence, BNB Chain, ERC Standards, ERC721, ERC1155, Solidity, and Upgradeable Smart Contracts. Introduce show-card for DeGov.AI and OpenZeppelin with comprehensive details on features, technology, and use cases. Ensure adherence to updated content structure and guidelines.
1 parent 7fb0a17 commit 83d24d9

13 files changed

+249
-117
lines changed

.cursor/rules/awesome-card.mdc

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,42 @@ alwaysApply: false
77

88
This rule defines the required content structure for an "awesome-card" in the Web3 Wiki, which curates a list of valuable resources related to a specific topic.
99

10-
## Content Structure
11-
12-
```markdown
13-
#awesome-card
14-
15-
## Introduction
16-
- **Topic Focus:** Clearly state the specific topic this list covers (e.g., Awesome [[Zero-Knowledge Proofs]], Awesome [[Solidity]] Resources).
17-
- **Purpose:** Explain *why* this curated list is useful (e.g., for developers learning X, for users exploring Y tools).
18-
- **Scope:** Briefly define what kind of resources are included and excluded.
19-
20-
## Official Resources
21-
- **Primary Website:** [Project/Concept Name Official Website Link] - Link to the main landing page.
22-
- **Documentation:** [Link to Official Docs] - Describe what the documentation covers (e.g., API reference, getting started guide).
23-
- **Whitepaper/Specifications:** [Link to Paper/Spec] - Briefly mention the core topic of the paper.
24-
25-
## Learning Materials
26-
- **Tutorials:** [Link to Tutorial] - Specify skill level (beginner, intermediate, advanced) and format (text, video).
27-
- **Courses:** [Link to Course] - Mention provider (e.g., Coursera, Udemy) and key learning outcomes.
28-
- **Books:** [Book Title] by [Author] ([Link to buy/info]) - Add publication year and target audience.
29-
- **Workshops/Guides:** [Link to Resource] - Describe the format and focus.
30-
31-
## Development Tools
32-
- **SDKs/Libraries:** [Tool Name] ([Link to Repo/Docs]) - Specify language/platform and primary function.
33-
- **Frameworks:** [Framework Name] ([Link]) - Mention the problem it solves or its main use case.
34-
- **Testing Tools:** [Tool Name] ([Link]) - Describe the type of testing it facilitates.
35-
- **IDEs/Plugins:** [Tool Name] ([Link]) - Specify the IDE it integrates with.
36-
37-
## Ecosystem & Community
38-
- **Key Projects/Implementations:** [[Project Card Name]] or [Project Name] ([Link]) - Link relevant `show-card`s or official project sites.
39-
- **Explorers:** [Explorer Name] ([Link]) - e.g., Etherscan, Solscan.
40-
- **Forums/Discussion:** [Link to Forum/Platform] - Mention primary focus (e.g., technical support, general discussion).
41-
- **Social Channels:** [Link to Discord/Twitter/etc.] - Specify the channel type.
42-
43-
## Further Resources (Optional)
44-
- **Blogs/Articles:** [Link to Article/Blog] - Mention author/publication and key topic.
45-
- **Newsletters:** [Newsletter Name] ([Link to Subscribe]) - Describe frequency and content focus.
46-
- **Podcasts/Videos:** [Podcast/Channel Name] ([Link]) - Mention key hosts or topics covered.
47-
```
10+
## Key Content Considerations
11+
12+
When creating or updating an `awesome-card`, ensure the following categories of resources are considered. The AI assistant should generate a logical content outline based on these key resource categories and the specific topic of the awesome list.
13+
14+
**1. Introduction:**
15+
- Topic Focus: Clearly state the specific topic (e.g., Awesome [[Zero-Knowledge Proofs]], Awesome [[Solidity]] Resources).
16+
- Purpose: Why this curated list is useful.
17+
- Scope: What kind of resources are included/excluded.
18+
19+
**2. Official Resources:**
20+
- Primary Website: Link to main landing page.
21+
- Documentation: Link to official docs (describe coverage).
22+
- Whitepaper/Specifications: Link to paper/spec (mention core topic).
23+
24+
**3. Learning Materials:**
25+
- Tutorials: Links with skill level and format.
26+
- Courses: Links with provider and key learning outcomes.
27+
- Books: Titles, authors, links (publication year, target audience).
28+
- Workshops/Guides: Links with format and focus.
29+
30+
**4. Development Tools (if applicable to the topic):**
31+
- SDKs/Libraries: Names, links (language/platform, function).
32+
- Frameworks: Names, links (problem solved/use case).
33+
- Testing Tools: Names, links (type of testing).
34+
- IDEs/Plugins: Names, links (IDE integration).
35+
36+
**5. Ecosystem & Community:**
37+
- Key Projects/Implementations: Links to `[[Project Card Name]]` or official sites.
38+
- Explorers: Names, links (e.g., Etherscan, Solscan).
39+
- Forums/Discussion: Links with primary focus.
40+
- Social Channels: Links with channel type (Discord, Twitter, etc.).
41+
42+
**6. Further Resources (Optional):**
43+
- Blogs/Articles: Links with author/publication and key topic.
44+
- Newsletters: Names, links (frequency, content focus).
45+
- Podcasts/Videos: Names, links (key hosts/topics covered).
4846

4947
## General Guidelines Adherence
5048

.cursor/rules/explain-card.mdc

Lines changed: 27 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,33 @@ alwaysApply: false
77

88
This rule defines the required content structure for an "explain-card" in the Web3 Wiki.
99

10-
## Content Structure
11-
12-
```markdown
13-
#explain-card
14-
15-
## Introduction
16-
17-
- **What it is:** Start with a clear, concise definition of the concept, at least 2 sentences. It would be longer if it's a complex concept.
18-
- **Analogy (Optional):** Use a simple analogy if it helps clarify the concept for beginners.
19-
- **Importance/Purpose:** Explain *why* this concept exists and why it's significant, especially within the Web3 context.
20-
- **Target Audience:** Briefly mention who this concept is most relevant to (e.g., developers, users, investors).
21-
22-
## Core Concepts
23-
24-
- **Key Components:** Break down the concept into its essential parts or elements. Explain each part clearly and deeply.
25-
- **Mechanism/How it Works:** Describe the process or workflow involved. Use diagrams or flowcharts if helpful (describe them in text).
26-
- **Technical Details:** Include relevant technical specifications, protocols, or algorithms. Explain technical details in a way that is easy to understand.
27-
- **Variations/Types (If applicable):** Mention different types or implementations of the concept if they exist (e.g., different types of consensus mechanisms for "Proof of Stake").
28-
29-
## Use Cases
30-
31-
- **Specific Examples:** Provide concrete examples of how this concept is used in real-world Web3 projects or scenarios. Link to relevant `show-card`s if available (e.g., [[Uniswap]] as an example of a DEX).
32-
- **Benefits:** Detail the advantages or positive outcomes of using this concept.
33-
- **Limitations/Challenges:** Discuss the drawbacks, risks, or challenges associated with the concept.
34-
- **Comparison (Optional):** Briefly compare it to alternative concepts or traditional (Web 2.0) approaches if relevant.
35-
36-
## Related Concepts (Optional)
37-
- **Prerequisites:** List any concepts the reader should understand before this one (e.g., [[Blockchain]] might be a prerequisite for [[Smart Contract]]).
38-
- **Building Blocks:** Link to concepts that are components of this one.
39-
- **Related Ideas:** Link to concepts that are similar, contrasting, or often discussed together.
40-
- **Further Reading:** Link to more advanced concepts that build upon this one.
41-
```
10+
## Key Content Considerations
11+
12+
When creating or updating an `explain-card`, ensure the following aspects are covered. The AI assistant should generate a logical content outline based on these key elements and the specific nature of the concept being explained.
13+
14+
**1. Introduction:**
15+
- Clear and concise definition of the concept (at least 2 sentences, longer if complex).
16+
- Analogy (optional, to clarify for beginners).
17+
- Importance/Purpose: Why the concept exists and its significance in Web3.
18+
- Target Audience (e.g., developers, users, investors).
19+
20+
**2. Core Concepts & Mechanism:**
21+
- Key Components: Essential parts or elements, explained clearly and deeply.
22+
- Mechanism/How it Works: The process or workflow involved (diagrams can be described in text).
23+
- Technical Details: Relevant specifications, protocols, or algorithms, explained accessibly.
24+
- Variations/Types (if applicable): Different implementations or types of the concept.
25+
26+
**3. Use Cases & Implications:**
27+
- Specific Examples: Real-world Web3 project examples (link to `show-card`s if available).
28+
- Benefits: Advantages or positive outcomes.
29+
- Limitations/Challenges: Drawbacks, risks, or difficulties.
30+
- Comparison (optional): To alternative concepts or Web 2.0 approaches.
31+
32+
**4. Related Concepts (Optional but Recommended):**
33+
- Prerequisites: Concepts to understand first.
34+
- Building Blocks: Component concepts.
35+
- Related Ideas: Similar, contrasting, or co-discussed concepts.
36+
- Further Reading: Advanced concepts building upon this one.
4237

4338
## General Guidelines Adherence
4439

.cursor/rules/show-card.mdc

Lines changed: 36 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,42 @@ alwaysApply: false
77

88
This rule defines the required content structure for a "show-card" in the Web3 Wiki, used to showcase a particular project, tool, or service.
99

10-
## Content Structure
11-
12-
```markdown
13-
#show-card
14-
15-
## Overview
16-
- **What it is:** A concise summary of the project, tool, or service (1-2 sentences).
17-
- **Problem Solved:** Clearly articulate the problem this project addresses in the Web3 space.
18-
- **Value Proposition:** What is the unique benefit or advantage it offers?
19-
- **Official Website:** [Link to Official Website]
20-
- **Status:** (e.g., Live, Beta, In Development) - Mention key dates if available (e.g., launch date).
21-
22-
## Key Features
23-
- List the main functionalities or capabilities. Use **bold** for the feature name.
24-
- **Feature 1:** Brief explanation of what it does and its benefit.
25-
- **Feature 2:** Brief explanation.
26-
- **Feature 3:** ... (Use paragraphs for more complex features if needed).
27-
28-
## Technology
29-
- **Blockchain/Platform:** Specify the primary blockchain(s) it runs on or integrates with (e.g., [[Ethereum]], [[Solana]], Standalone).
30-
- **Architecture:** Briefly describe the high-level technical design or components.
31-
- **Core Mechanism:** Explain the key technical innovation or process if applicable (e.g., consensus method, scaling solution).
32-
- **Smart Contracts:** [Link to relevant contracts on explorer] (Optional) - Mention key audited contracts if applicable.
33-
34-
## Ecosystem & Use Cases
35-
- **Target Audience:** Who are the primary users? (e.g., Developers, DeFi Traders, NFT Collectors).
36-
- **How it's Used:** Provide specific examples of how people interact with the project.
37-
- **Integrations:** Mention notable projects or platforms it integrates with.
38-
- **Tokenomics (If applicable):** Briefly describe the native token's utility, supply, and distribution model. Link to [[Token Name]] card if it exists.
39-
40-
## Getting Started & Resources
41-
- **Accessing:** How does a user start using it? (e.g., Web app link, download link, API key signup).
42-
- **Documentation:** [Link to Official Documentation]
43-
- **Community:** [Link to Discord/Telegram/Forum]
44-
- **Support:** [Link to Support Channel/FAQ]
45-
- **Source Code:** [Link to GitHub/GitLab Repo] (If open source).
46-
47-
## Related Concepts
48-
- Link to relevant `explain-card`s for underlying technologies or concepts (e.g., Built using [[Optimistic Rollups]], Implements [[Decentralized Identity]]).
49-
- Link to relevant `awesome-card`s (e.g., See [[Awesome DeFi Tools]]).
50-
```
10+
## Key Content Considerations
11+
12+
When creating or updating a `show-card`, ensure the following aspects are covered. The AI assistant should generate a logical content outline based on these key elements and the specific nature of the project/tool/service being showcased.
13+
14+
**1. Overview:**
15+
- Concise summary of the project/tool/service (1-2 sentences).
16+
- Problem Solved: The issue it addresses in Web3.
17+
- Value Proposition: Its unique benefit or advantage.
18+
- Official Website: Link to the official site.
19+
- Status (e.g., Live, Beta, In Development, key dates).
20+
21+
**2. Key Features:**
22+
- Main functionalities or capabilities, with brief explanations of each and their benefits.
23+
24+
**3. Technology:**
25+
- Blockchain/Platform (e.g., [[Ethereum]], [[Solana]], Standalone).
26+
- Architecture: High-level technical design/components.
27+
- Core Mechanism: Key technical innovation or process.
28+
- Smart Contracts: Links to relevant contracts (optional, mention audited contracts).
29+
30+
**4. Ecosystem & Use Cases:**
31+
- Target Audience (e.g., Developers, DeFi Traders, NFT Collectors).
32+
- How it's Used: Specific examples of interaction.
33+
- Integrations: Notable projects/platforms it integrates with.
34+
- Tokenomics (if applicable): Native token's utility, supply, distribution (link to `[[Token Name]]` card).
35+
36+
**5. Getting Started & Resources:**
37+
- Accessing: How to start using it (e.g., web app, download, API signup).
38+
- Documentation: Link to official documentation.
39+
- Community: Link to Discord/Telegram/Forum.
40+
- Support: Link to support channel/FAQ.
41+
- Source Code: Link to GitHub/GitLab (if open source).
42+
43+
**6. Related Concepts:**
44+
- Links to relevant `explain-card`s (underlying technologies, e.g., Built using [[Optimistic Rollups]]).
45+
- Links to relevant `awesome-card`s (e.g., See [[Awesome DeFi Tools]]).
5146

5247
## General Guidelines Adherence
5348

.cursor/rules/wiki-guide.mdc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Each card must belong to one of the following three categories:
2929
- **Mandatory Category Tag:**
3030
- The very first line of every card file _must_ be the tag corresponding to its category (e.g., `#explain-card`, `#show-card`, `#awesome-card`), with **no preceding blank lines or content**. This is further detailed in the specific card type rule files.
3131
- **File Location:**
32-
- All new card markdown files **MUST** be created **directly within the `cards` directory** (e.g., `cards/My New Card.md`).
32+
- All new card markdown files **MUST** be created **directly within the `cards` directory** (e.g., `cards/My New Card.md`). **This is a strict requirement.**
3333
- No subdirectories within `cards` should be used for card storage unless explicitly specified in a future rule update.
34-
- The AI assistant **MUST NOT** create card files in any other directory (e.g., the workspace root, `.cursor/rules/`, etc.). **Verify the creation path.**
34+
- The AI assistant **MUST NOT** create card files in any other directory (e.g., the workspace root, `.cursor/rules/`, etc.). **Verify the creation path rigorously.**
3535

3636
## Card Content Rules
3737

@@ -49,7 +49,12 @@ These guidelines apply to all cards and content within the wiki.
4949
- Links **must** point to existing card files (case-sensitive filename, `.md` implied) located **directly within the `cards` directory**.
5050
- **Verification is mandatory:** Before adding an internal link, confirm the target file exists (use `list_dir` or `file_search`).
5151
- **No Broken Links:** Broken internal links are strictly forbidden.
52-
- **Handling Missing Targets:** If a potentially useful link target doesn't exist, either create the card first (following all rules) or omit the link.
52+
- **Handling Missing Targets:** If a potentially useful link target doesn't exist, the AI assistant **MUST**:
53+
1. Determine the most appropriate card category for the new concept (e.g., `#explain-card`, `#show-card`).
54+
2. Create the new card file (e.g., `cards/New Concept.md`) **directly within the `cards` directory**, adhering to all naming conventions (uppercase first letter, appropriate filename).
55+
3. Add the chosen category tag as the very first line of the new card file.
56+
4. Generate initial, relevant content for this new card based on its chosen category, the context of the link, and available knowledge. The goal is to create a useful stub, not just an empty file. Refer to the specific card type rules for content guidance.
57+
5. If creating a populated stub is not feasible or the concept is too broad/unknown, the link should be omitted. **Do not create empty or near-empty files.**
5358
- **External Links (`[Text](mdc:URL)`):**
5459
- Prioritize links to **official websites, documentation, or primary sources**, especially for projects, tools, and resources.
5560
- Use **descriptive link text** (e.g., `[Official Ethereum Website]`) instead of generic terms like "here" or "link".
@@ -80,10 +85,10 @@ As an AI assistant, your role is to proactively maintain and improve the Web3 Wi
8085
4. **Implement Changes:** Propose and apply specific, constructive changes to address identified issues, clearly stating the intent. Use web search and fetching tools to gather up-to-date information for content revisions.
8186
5. **Link Management:**
8287
- Actively create relevant internal links, ensuring they are valid by **verifying target file existence first**.
83-
- When a target is missing, follow the `Handling Missing Targets` rule (create card or omit link).
88+
- When a target is missing, follow the updated `Handling Missing Targets` rule (i.e., determine category, create the card file **in the `cards` directory with initial content**, or omit the link).
8489
- Ensure external links adhere to the `Linking Standards`, using web search/fetch for verification.
8590
6. **Card Creation:**
86-
- When creating new cards (e.g., to fulfill a missing link), ensure they are created **directly within the `cards` directory**.
87-
- Strictly adhere to all `Card Naming and Format` rules (uppercase first letter, category tag on the first line) and the specific content structure for the chosen card type.
91+
- When creating new cards (e.g., to fulfill a missing link as per `Handling Missing Targets`, or by direct user request), ensure they are created **directly and exclusively within the `cards` directory**. This path (`cards/FILENAME.md`) is non-negotiable.
92+
- Strictly adhere to all `Card Naming and Format` rules (uppercase first letter, descriptive name, category tag on the first line) and generate meaningful initial content according to the specific content considerations for the chosen card type.
8893
7. **Exception - Main Page:** The card `Web3 Wiki.md` serves as the main page of the wiki. The AI assistant **MUST NOT** modify the content of this card. It is maintained manually.
8994

cards/Artificial Intelligence.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#explain-card
2+
3+
Artificial Intelligence (AI) refers to the simulation of human intelligence in machines that are programmed to think like humans and mimic their actions.

cards/BNB Chain.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#explain-card
2+
3+
BNB Chain is a blockchain platform developed by Binance, known for its high performance and low transaction fees.

0 commit comments

Comments
 (0)