Skip to content

Commit 1eb67b5

Browse files
committed
Update wording to be clear and concise
1 parent b25f52b commit 1eb67b5

File tree

3 files changed

+15
-20
lines changed

3 files changed

+15
-20
lines changed

.CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,17 @@ Before making contributions, you need to set up the proper directory structure f
5757

5858
1. **Clone the MkDocs repository**
5959

60+
> **polkadot-mkdocs**: Contains the "engine" (MkDocs configuration, theme, styling)
61+
6062
```bash
6163
git clone https://github.com/papermoonio/polkadot-mkdocs
6264
cd polkadot-mkdocs
6365
```
6466

6567
2. **Fork and clone the docs repository inside polkadot-mkdocs**
6668

69+
> **polkadot-docs**: Contains the "content" (documentation pages, tutorials, images)
70+
6771
```bash
6872
# Fork polkadot-docs on GitHub first, then:
6973
git clone https://github.com/your-username/polkadot-docs.git

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Choose one:
88
- [ ] ✅ I have time to handle formatting/style feedback myself
99
- [ ] ⚡ Docs team handles formatting (check "Allow edits from maintainers")
1010

11-
## 🤖 AI Docs
11+
## 🤖 AI-Ready Docs
1212

13-
If content changed, regenerate AI files:
13+
If content changed, [regenerate AI files](../CONTRIBUTING.md#making-changes):
1414
- [ ] ✅ I ran `python3 scripts/generate_llms.py`
1515
- [ ] ⚡ Docs team will regenerate (check "Allow edits from maintainers")
1616

1717
## ✅ Checklist
1818

1919
- [ ] Changes tested
20-
- [ ] [PaperMoon Style Guide](https://github.com/papermoonio/documentation-style-guide) followed
20+
- [ ] [PaperMoon Style Guide](https://github.com/papermoonio/documentation-style-guide) followed

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Follow these steps to run the documentation site locally and preview your change
1212

1313
Building and serving the site requires cloning two repositories:
1414

15-
- **[Polkadot MkDocs](https://github.com/papermoonio/polkadot-mkdocs)**: Contains the MkDocs configuration files, theme overrides, and custom CSS for the Polkadot documentation site.
15+
- **[Polkadot MkDocs](https://github.com/papermoonio/polkadot-mkdocs)**: Contains the "engine" (MkDocs configuration, theme overrides, and custom CSS) for the Polkadot documentation site.
1616

17-
- **[Polkadot Docs](https://github.com/polkadot-developers/polkadot-docs)**: The actual content is stored in the `polkadot-docs` repository and pulled into the `polkadot-mkdocs` directory during build.
17+
- **[Polkadot Docs](https://github.com/polkadot-developers/polkadot-docs)**: Contains the "content" (documentation pages, tutorials, and images) that gets built into the site.
1818

1919
For everything to work correctly, the file structure needs to be as follows:
2020

@@ -71,23 +71,14 @@ pip install -r requirements.txt
7171

7272
After a successful build, the site should be available at http://127.0.0.1:8000.
7373

74-
### Deactivating the Virtual Environment
74+
### Working with the Docs
7575

76-
When you're done working on the documentation, you can deactivate the virtual environment by running:
76+
When you're done working, run `deactivate` to exit the virtual environment.
7777
78-
```bash
79-
deactivate
80-
```
81-
82-
### Next Time You Work on the Docs
83-
84-
When you return to work on the documentation:
85-
86-
1. Navigate to the `polkadot-mkdocs` directory
87-
2. Activate the virtual environment:
88-
- macOS/Linux: `source venv/bin/activate`
89-
- Windows: `venv\Scripts\activate`
90-
3. Run `mkdocs serve` to start the development server
78+
To work on the docs again:
79+
1. Navigate to `polkadot-mkdocs`
80+
2. Activate the environment: `source venv/bin/activate` (Windows: `venv\Scripts\activate`)
81+
3. Run `mkdocs serve`
9182
9283
## Contributing
9384

0 commit comments

Comments
 (0)