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
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,25 @@
1
1
## Short Description
2
+
2
3
<!--- Shortly describe what this PR introduces. -->
3
4
<!--- For help on writing docs, visit https://docs.webiny.com/docs/contributing/documentation -->
4
5
5
6
## Relevant Links
7
+
6
8
<!--- If possible, please include the URLs of the newly added or edited pages (wait for the Netlify preview to be deployed and then paste the links). -->
9
+
7
10
-[A change on X page](#)
8
11
-[Update list of libraries](#)
9
12
-[A new diagram with updated resources](#)
10
13
11
14
## Checklist
15
+
12
16
-[ ] I added page metadata (description, keywords)
13
17
-[ ] I've added "Can I Use This?" section (if needed, e.g. if documenting a new feature)
14
18
-[ ] I added `What You'll Learn` at the top of the page and every item in the list starts with a lower case letter
15
19
-[ ] I used title case for titles and subtitles (in the main menu and in the page content)
16
20
-[ ] I checked for typos and grammar mistakes
17
21
-[ ] I added `alt` / `title` attributes for inserted images (if any)
18
-
-[ ] When linking code from GitHub, I did it via a specific tag (and not `next` / `v5` branch)
22
+
-[ ] When linking code from GitHub, I did it via a specific tag (and not `next` / `v5` branch)
19
23
20
24
<!--- Resources:
21
25
- new document template: https://docs.webiny.com/docs/contributing/documentation#template-for-new-docs
Copy file name to clipboardExpand all lines: AGENTS.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,15 @@
8
8
- All script execution: `yarn <script-name>`
9
9
- All package operations: `yarn add`, `yarn install`, etc.
10
10
11
+
### Release Notes / Changelog Editing
12
+
13
+
When editing a generated `changelog.mdx` file, always keep the sibling `changelog.ai.txt` in sync — without being asked:
14
+
15
+
-**Removed entry** → add the PR number(s) to the `## Skipped PRs` section with a short reason
16
+
-**Rewritten entry** → add a note to the `## Manual Rewrites` section
17
+
18
+
The `generate-changelog.ts` script reads `## Skipped PRs` to avoid re-adding manually removed entries on the next run. If `changelog.ai.txt` is not updated, removed PRs will reappear.
19
+
11
20
### Validation and Quality
12
21
13
22
-**MDX/.ai.txt Pairing**: Every `.mdx` file must have a corresponding `.ai.txt` companion file
@@ -33,7 +42,7 @@
33
42
```
34
43
docs/developer-docs/6.0.x/
35
44
├── admin/ # Admin area customization (whitelabeling)
36
-
├── webiny-api/ # API customization (custom domain, extend GraphQL schema, universal API keys)
45
+
├── webiny-api/ # API customization (custom domain, extend GraphQL schema, custom routes, universal API keys)
0 commit comments