Skip to content

Commit 1171149

Browse files
update contributing
1 parent ffb9bd3 commit 1171149

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

.CONTRIBUTING/.CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For tutorial contributions, please see our [tutorial contribution guidelines](.C
2828
- [Types of Contributions](#types-of-contributions)
2929
- [Contents](#contents)
3030
- [Contribution Workflow](#contribution-workflow)
31-
- [Generating AI-Ready Documentation](#generating-ai-ready-documentation)
31+
- [Generating AI-Ready Documentation](#generating-ai-ready-documentation)
3232
- [Viewing Site Locally](#viewing-site-locally)
3333
- [Clone Repositories](#clone-repositories)
3434
- [Install Dependencies and Serve Site](#install-dependencies-and-serve-site)
@@ -50,32 +50,39 @@ For tutorial contributions, please see our [tutorial contribution guidelines](.C
5050
Follow these steps when contributing documentation fixes, improvements, or new content:
5151

5252
1. **Fork and Create Branch**
53+
5354
```bash
5455
git clone https://github.com/your-username/polkadot-docs.git
5556
cd polkadot-docs
5657
git checkout -b your-feature-branch
5758
```
5859

5960
2. **Make Your Changes**
61+
6062
- Edit existing files or add new content
6163
- Follow the [style guide](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md)
6264
- Test your changes locally (see [Viewing Site Locally](#viewing-site-locally))
6365

6466
3. **Generate Updated AI Documentation**
67+
6568
After making content changes, regenerate the AI-ready documentation files:
69+
6670
```bash
6771
python3 scripts/generate_llms_standard.py
6872
```
73+
6974
This updates the `llms.txt` and `llms-full.txt` files that power our AI-ready documentation.
70-
75+
7176
**Note**: This script needs to be run on every PR once all changes have been committed.
7277

7378
4. **Create Pull Request**
79+
7480
- Push your branch and create a pull request
7581
- Use the PR template to indicate your review preference
7682
- Include a clear description of your changes
7783

7884
5. **Review Process Choice**
85+
7986
In your pull request, please let us know:
8087
- **Option A**: "I have time to handle formatting and style review feedback myself"
8188
- **Option B**: "Please have the Polkadot docs team take over for formatting review to expedite the process"
@@ -86,24 +93,23 @@ Follow these steps when contributing documentation fixes, improvements, or new c
8693

8794
### Hand-off Process (Internal Team Workflow)
8895

89-
When a contributor chooses Option B but does not have "Allow edits from maintainers" enabled, or when a contributor (regardless of option chosen) becomes unresponsive during review:
96+
When a contributor chooses Option B (or becomes unresponsive) and does not have "Allow edits from maintainers" enabled, the following workflow will apply:
9097

9198
1. **Create Intermediary Branch**: Create a new branch named `follow-up/PR-[original_pr_number]`
9299
2. **Redirect Original PR**: Change the destination of the original PR to the intermediary branch
93100
3. **Complete Formatting Review**: Perform style and formatting reviews on the intermediary branch
94101
4. **Final Merge**: Merge the completed intermediary branch into master
95102

96-
If the contributor selects Option B AND allows edits from maintainers then we can perform changes directly on the contributor's branch.
97103

98-
## Generating AI-Ready Documentation
104+
### Generating AI-Ready Documentation
99105

100106
When you modify content in the documentation, you should regenerate the AI-ready files to keep them current:
101107

102-
### Prerequisites
108+
#### Prerequisites
103109
- Python 3.x installed
104110
- Required Python packages (run `pip install -r requirements.txt` in the project root)
105111

106-
### Generate llms.txt Files
112+
#### Generate llms.txt Files
107113
```bash
108114
cd /path/to/polkadot-docs
109115
python3 scripts/generate_llms_standard.py

0 commit comments

Comments
 (0)