You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: .cursor/rules/awesome-card.mdc
+36-38Lines changed: 36 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -7,44 +7,42 @@ alwaysApply: false
7
7
8
8
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.
9
9
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.
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.
Copy file name to clipboardExpand all lines: .cursor/rules/explain-card.mdc
+27-32Lines changed: 27 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -7,38 +7,33 @@ alwaysApply: false
7
7
8
8
This rule defines the required content structure for an "explain-card" in the Web3 Wiki.
9
9
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.
Copy file name to clipboardExpand all lines: .cursor/rules/show-card.mdc
+36-41Lines changed: 36 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -7,47 +7,42 @@ alwaysApply: false
7
7
8
8
This rule defines the required content structure for a "show-card" in the Web3 Wiki, used to showcase a particular project, tool, or service.
9
9
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.
Copy file name to clipboardExpand all lines: .cursor/rules/wiki-guide.mdc
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -29,9 +29,9 @@ Each card must belong to one of the following three categories:
29
29
- **Mandatory Category Tag:**
30
30
- 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.
31
31
- **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.**
33
33
- 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.**
35
35
36
36
## Card Content Rules
37
37
@@ -49,7 +49,12 @@ These guidelines apply to all cards and content within the wiki.
49
49
- Links **must** point to existing card files (case-sensitive filename, `.md` implied) located **directly within the `cards` directory**.
50
50
- **Verification is mandatory:** Before adding an internal link, confirm the target file exists (use `list_dir` or `file_search`).
51
51
- **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.**
53
58
- **External Links (`[Text](mdc:URL)`):**
54
59
- Prioritize links to **official websites, documentation, or primary sources**, especially for projects, tools, and resources.
55
60
- 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
80
85
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.
81
86
5. **Link Management:**
82
87
- 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).
84
89
- Ensure external links adhere to the `Linking Standards`, using web search/fetch for verification.
85
90
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.
88
93
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.
Artificial Intelligence (AI) refers to the simulation of human intelligence in machines that are programmed to think like humans and mimic their actions.
0 commit comments