Skip to content

Commit 756007b

Browse files
committed
Update content
1 parent 6d45bb9 commit 756007b

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

.CONTRIBUTING.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ For simple contributions like fixing typos or making small text changes, you can
4646
- Fork the repository to your account.
4747
- Create a branch with your changes.
4848
- Open a pull request.
49+
- Make sure to check "Allow edits from maintainers"
4950

5051
## Fork and Edit Locally
5152

@@ -113,8 +114,6 @@ Making changes to existing pages is the simplest contribution:
113114
2. **Follow page requirements**: Ensure your changes maintain proper formatting.
114115
3. **Test locally**: Verify your changes render correctly.
115116

116-
**No additional files need updating** when you're only modifying existing content.
117-
118117
## Add a New Page
119118

120119
**Requirement**: Follow the [PaperMoon Documentation Style Guide](https://github.com/papermoonio/documentation-style-guide).
@@ -129,6 +128,7 @@ To add a page to an existing section:
129128
---
130129
title: Page Title (max 60 chars for SEO)
131130
description: Description for SEO (120-160 chars)
131+
categories: Category1, Category2
132132
---
133133

134134
# Page Title
@@ -142,6 +142,12 @@ To add a page to an existing section:
142142
List any required tools, knowledge, or setup.
143143
```
144144

145+
**Categories**
146+
147+
Available categories for pages are found in [scripts/llms_config.json](./scripts/llms_config.json).
148+
149+
**Search Engine Optimization (SEO)**
150+
145151
Resources for good SEO:
146152
- [Google's title recommendations](https://developers.google.com/search/docs/advanced/appearance/title-link?hl=en)
147153
- [Google's description recommendations](https://developers.google.com/search/docs/advanced/appearance/snippet?hl=en)
@@ -180,7 +186,14 @@ To create an entirely new section of documentation:
180186
- Files: `'Display Name': 'file-name.md'`
181187
- Subdirectories: Listed by directory name
182188

183-
3. **Create `index.md`** - Landing page with frontmatter and content introducing the section
189+
3. Create the `index.md` landing page with frontmatter and content introducing the section.
190+
191+
- In the `index.md` add the following snippet to display what content is available in the section:
192+
```markdown
193+
## In This Section
194+
195+
:::INSERT_IN_THIS_SECTION:::
196+
```
184197

185198
## Write a Tutorial
186199

@@ -239,10 +252,6 @@ How to confirm it worked
239252
Related tutorials
240253
```
241254

242-
### Tutorial Categories
243-
244-
Available categories for tutorials are found in [scripts/llms_config.json](./scripts/llms_config.json).
245-
246255
### Tutorial Requirements
247256

248257
- All code examples must be tested and functional.

llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
- [Storage](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/integrations/storage.md): Explore decentralized storage solutions for your Polkadot dApp. Discover key integrations, such as Crust and IPFS, for robust, censorship-resistant data storage.
8989
- [Transaction Construction](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/integrations/transaction-construction.md): Understand how to construct, sign, and broadcast transactions in the Polkadot ecosystem using various tools and libraries.
9090
- [Wallets](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/integrations/wallets.md): Explore blockchain wallets. Securely manage digital assets with hot wallets for online access or cold wallets for offline, enhanced security.
91-
- [Interoperability](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/interoperability/index.md): Explore Polkadot's XCM tooling ecosystem, featuring the Asset Transfer API and other utilities for implementing cross-chain messaging and transfers.
91+
- [Interoperability](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/interoperability/index.md): Explore Polkadot's XCM tooling ecosystem, featuring utilities for implementing cross-chain messaging and transfers.
9292
- [ParaSpell XCM SDK](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/interoperability/paraspell-xcm-sdk/index.md): A powerful open-source library that simplifies XCM integration, enabling developers to easily build interoperable dApps on Polkadot.
9393
- [XCM Tools](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/interoperability/xcm-tools.md): Explore essential XCM tools across Polkadot, crafted to enhance cross-chain functionality and integration within the ecosystem.
9494
- [E2E Testing on Polkadot SDK Chains](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/develop/toolkit/parachains/e2e-testing/index.md): Discover a suite of tools for E2E testing on Polkadot SDK-based blockchains, including configuration management, automation, and debugging utilities.

0 commit comments

Comments
 (0)