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
- Follow the [style guide](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md)
62
64
- Test your changes locally (see [Viewing Site Locally](#viewing-site-locally))
63
65
64
66
3.**Generate Updated AI Documentation**
67
+
65
68
After making content changes, regenerate the AI-ready documentation files:
69
+
66
70
```bash
67
71
python3 scripts/generate_llms_standard.py
68
72
```
73
+
69
74
This updates the `llms.txt` and `llms-full.txt` files that power our AI-ready documentation.
70
-
75
+
71
76
**Note**: This script needs to be run on every PR once all changes have been committed.
72
77
73
78
4.**Create Pull Request**
79
+
74
80
- Push your branch and create a pull request
75
81
- Use the PR template to indicate your review preference
76
82
- Include a clear description of your changes
77
83
78
84
5.**Review Process Choice**
85
+
79
86
In your pull request, please let us know:
80
87
-**Option A**: "I have time to handle formatting and style review feedback myself"
81
88
-**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
86
93
87
94
### Hand-off Process (Internal Team Workflow)
88
95
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:
90
97
91
98
1.**Create Intermediary Branch**: Create a new branch named `follow-up/PR-[original_pr_number]`
92
99
2.**Redirect Original PR**: Change the destination of the original PR to the intermediary branch
93
100
3.**Complete Formatting Review**: Perform style and formatting reviews on the intermediary branch
94
101
4.**Final Merge**: Merge the completed intermediary branch into master
95
102
96
-
If the contributor selects Option B AND allows edits from maintainers then we can perform changes directly on the contributor's branch.
97
103
98
-
## Generating AI-Ready Documentation
104
+
###Generating AI-Ready Documentation
99
105
100
106
When you modify content in the documentation, you should regenerate the AI-ready files to keep them current:
101
107
102
-
### Prerequisites
108
+
####Prerequisites
103
109
- Python 3.x installed
104
110
- Required Python packages (run `pip install -r requirements.txt` in the project root)
0 commit comments