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
All card Markdown files **MUST** be placed **directly within the `cards` directory** (e.g., `cards/My New Card.md`). This is a strict requirement.
36
+
All card Markdown files **MUST** be placed **directly within the `cards` directory** (e.g., `cards/My new card.md`). This is a strict requirement.
37
37
38
38
#### Card Naming Conventions
39
39
40
-
1. The filename of a card should accurately represent its core topic. Use standard capitalization (e.g., `Smart Contract.md`, not `smart contract.md`).
41
-
2. The first letter of the filename **MUST** be uppercase (e.g., `Proof of Stake.md`, `Metamask.md`, `Zero-Knowledge Proofs.md`).
40
+
#### Card Naming Conventions
41
+
42
+
1. The filename of a card should accurately represent its core topic.
43
+
2. No special characters are allowed in the filename, only letters, numbers, and spaces. Only the first letter of the first word should be capitalized, and the rest should be in lowercase (e.g., `Decentralized finance.md`, `Smart contracts.md`).
44
+
- Example: `Decentralized finance.md` is acceptable, while `decentralized-finance.md` or `Decentralized-Finance.md` are not.
45
+
- Example: `Smart contracts.md` is acceptable, while `smart_contracts.md` or `SmartContracts.md` are not.
42
46
3. For concepts with commonly used abbreviations (e.g., EIP55, ERC721, ERC1155), follow the most widely accepted naming convention (e.g., `EIP55.md`, `ERC721.md`, `ERC1155.md`).
43
47
4. The filename **MUST** be unique within the `cards` directory. No two cards can have the same filename.
44
-
5. The filename **MUST** be descriptive and relevant to the card's content. Avoid generic names like `Card1.md` or `New Card.md`.
45
-
6. Filenames **MUST NOT** contain special characters. Use spaces to separate words if necessary (e.g., `Decentralized Finance.md`).
48
+
5. The filename **MUST** be descriptive and relevant to the card's content. Avoid generic names like `Card1.md` or `New card.md`.
49
+
6. Filenames **MUST NOT** contain special characters. Use spaces to separate words if necessary (e.g., `Decentralized finance.md`).
50
+
46
51
47
52
#### Card Links
48
53
49
54
Since this wiki is built using Obsidian, two types of links can be used within cards: internal and external.
50
55
51
-
* **Internal Links:** These links point to existing cards within the wiki. They are created using the syntax `[[Page Name]]`, where `Page Name` is the name of the target card (e.g., `[[Ethereum]]` links to `Ethereum.md`). Internal links connect related concepts and provide easy navigation. It is crucial to ensure all internal links are valid.
56
+
* **Internal Links:** These links point to existing cards within the wiki. They are created using the syntax `[[Page name]]`, where `Page name` is the name of the target card (e.g., `[[Ethereum]]` links to `Ethereum.md`). Internal links connect related concepts and provide easy navigation. It is crucial to ensure all internal links are valid.
52
57
* **External Links:** These links point to external resources like official websites or documentation. They are created using the syntax `[Text](mdc:URL)`, where `Text` is the clickable text and `URL` is the target link (e.g., `[Ethereum Official Website](mdc:https:/ethereum.org)`). External links provide additional context and references.
53
58
54
59
##### Internal Links Guidelines
55
60
56
61
* A script stores all existing card names in `scripts/card_index.txt` (one name per line, without the `.md` extension). Use this file to verify if a card name exists before creating a new card.
57
-
* Use the `[[Page Name]]` syntax for internal links. If the target card doesn't exist, ask the user for confirmation before creating it. The new card must follow all rules.
62
+
* Use the `[[Page name]]` syntax for internal links. If the target card doesn't exist, ask the user for confirmation before creating it. The new card must follow all rules.
58
63
59
64
##### External Links Guidelines
60
65
@@ -89,6 +94,7 @@ After creating or updating a card, perform a final review to ensure all guidelin
89
94
90
95
* **Run the command ` python3 scripts/check-tag.py`**: This script checks for the correct category tag at the beginning of each card. Fix any reported errors.
91
96
* **Run the command `python3 scripts/check-internal-links.py`**: This script checks for broken internal links. Fix any reported errors.
97
+
* **Run the command `python3 scripts/check-card-name.py`**: This script checks for card name violations in the `cards` directory. Fix any reported errors.
92
98
* **Cross-linking**: Review the card for mentions of concepts, projects, or technologies that could be linked to existing cards (check `scripts/card_index.txt` if necessary). Add internal links to enhance the knowledge network. Update linked cards if they lack detail or accuracy.
93
99
* **References and Citations**: Where possible, provide references to primary sources, official documentation, or reputable third-party analyses.
94
100
* **No Superficial Content**: Avoid brief, generic, or placeholder content. Every card should aim to be a definitive, standalone resource, similar in quality and depth to a well-maintained Wikipedia article.
0 commit comments