Allow articles with missing shortTitles to appear on home page (#54389) · github/docs@bb142f9 · GitHub
Skip to content

Commit bb142f9

Browse files
hectorsectorhectorsector
authored
Allow articles with missing shortTitles to appear on home page (#54389)
1 parent 7b14d4b commit bb142f9

36 files changed

Lines changed: 82 additions & 29 deletions

‎content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md‎

Lines changed: 1 addition & 1 deletion

content/copilot/example-prompts-for-github-copilot-chat/debugging-errors/debugging-invalid-json.md renamed to content/copilot/copilot-chat-cookbook/debugging-errors/debugging-invalid-json.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Debugging invalid JSON
33
shortTitle: Debug invalid JSON
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can identify and resolve syntax errors or structural issues in JSON data.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/debugging-errors/debugging-invalid-json
57
versions:
68
feature: copilot
79
category:

content/copilot/example-prompts-for-github-copilot-chat/debugging-errors/handling-api-rate-limits.md renamed to content/copilot/copilot-chat-cookbook/debugging-errors/handling-api-rate-limits.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Handling API rate limits
33
shortTitle: Handle API rate limits
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can help handle API rate limits by suggesting code that detects implements retry logic.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/debugging-errors/handling-api-rate-limits
57
versions:
68
feature: copilot
79
category:
@@ -32,7 +34,7 @@ def get_weather():
3234
city = request.args.get('city')
3335
# Simulate an API request to the external weather service
3436
response = requests.get(WEATHER_API_URL, params={"city": city})
35-
weather_data = response.json()
37+
weather_data = response.json()
3638

3739
return weather_data
3840
```

content/copilot/example-prompts-for-github-copilot-chat/debugging-errors/index.md renamed to content/copilot/copilot-chat-cookbook/debugging-errors/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Debugging errors
33
intro: 'Discover ways that you can use {% data variables.product.prodname_copilot %} to debug errors during development.'
4+
redirect_from:
5+
- /copilot/example-prompts-for-github-copilot-chat/debugging-errors
46
versions:
57
feature: copilot
68
topics:

content/copilot/example-prompts-for-github-copilot-chat/documenting-code/documenting-legacy-code.md renamed to content/copilot/copilot-chat-cookbook/documenting-code/documenting-legacy-code.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Documenting legacy code'
33
shortTitle: Document legacy code
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with documenting legacy code.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/documenting-legacy-code
57
versions:
68
feature: copilot
79
category:
@@ -59,8 +61,8 @@ INSERT-AND-VALIDATE.
5961
ELSE
6062
EXEC SQL ROLLBACK END-EXEC
6163
SET FAILED TO TRUE
62-
STRING "DB Error: " SQLCODE
63-
DELIMITED BY SIZE
64+
STRING "DB Error: " SQLCODE
65+
DELIMITED BY SIZE
6466
INTO WS-ERROR-MSG
6567
DISPLAY WS-ERROR-MSG
6668
END-IF
@@ -134,8 +136,8 @@ For example:
134136
ELSE
135137
EXEC SQL ROLLBACK END-EXEC *> Rollback if failed
136138
SET FAILED TO TRUE
137-
STRING "DB Error: " SQLCODE
138-
DELIMITED BY SIZE
139+
STRING "DB Error: " SQLCODE
140+
DELIMITED BY SIZE
139141
INTO WS-ERROR-MSG
140142
DISPLAY WS-ERROR-MSG
141143
END-IF

content/copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-complex-algorithms-or-logic.md renamed to content/copilot/copilot-chat-cookbook/documenting-code/explaining-complex-algorithms-or-logic.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Explaining complex algorithms or logic'
33
shortTitle: Explain complex logic
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can help add clear and concise documentation on complex algorithms or logic.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-complex-algorithms-or-logic
57
versions:
68
feature: copilot
79
category:

content/copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-legacy-code.md renamed to content/copilot/copilot-chat-cookbook/documenting-code/explaining-legacy-code.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Explaining legacy code'
33
shortTitle: Explain legacy code
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with explaining unfamiliar code.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-legacy-code
57
versions:
68
feature: copilot
79
category:
@@ -60,8 +62,8 @@ INSERT-AND-VALIDATE.
6062
ELSE
6163
EXEC SQL ROLLBACK END-EXEC
6264
SET FAILED TO TRUE
63-
STRING "DB Error: " SQLCODE
64-
DELIMITED BY SIZE
65+
STRING "DB Error: " SQLCODE
66+
DELIMITED BY SIZE
6567
INTO WS-ERROR-MSG
6668
DISPLAY WS-ERROR-MSG
6769
END-IF

content/copilot/example-prompts-for-github-copilot-chat/documenting-code/index.md renamed to content/copilot/copilot-chat-cookbook/documenting-code/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Documenting code
33
intro: 'Discover ways that you can use {% data variables.product.prodname_copilot_chat %} to document your code.'
4+
redirect_from:
5+
- /copilot/example-prompts-for-github-copilot-chat/documenting-code
46
versions:
57
feature: copilot
68
topics:

content/copilot/example-prompts-for-github-copilot-chat/documenting-code/syncing-documentation-with-code-changes.md renamed to content/copilot/copilot-chat-cookbook/documenting-code/syncing-documentation-with-code-changes.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: 'Syncing documentation with code changes'
33
shortTitle: Sync documentation
44
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with keeping code documentation up-to-date.'
5+
redirect_from:
6+
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/syncing-documentation-with-code-changes
57
versions:
68
feature: copilot
79
category:
@@ -22,14 +24,14 @@ It can be difficult to keep documentation up to date with changes to code. Howev
2224
```typescript
2325
/**
2426
* Retrieves all products belonging to a specific category.
25-
*
27+
*
2628
* @param categoryId - The unique identifier of the product category
2729
* @returns Promise that resolves to an array of Product objects
28-
*
30+
*
2931
* @example
3032
* const products = await getByCategoryName(5);
3133
* // Returns: [{id: 1, name: "Product 1", categoryId: 5}, ...]
32-
*
34+
*
3335
* @throws {PrismaClientKnownRequestError} If database query fails
3436
* @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}
3537
*/
@@ -65,16 +67,16 @@ For example:
6567
```typescript
6668
/**
6769
* Retrieves all products belonging to a specific category with pagination and recent reviews.
68-
*
70+
*
6971
* @param categoryId - The unique identifier of the product category
7072
* @param page - The page number for pagination (default: 1)
7173
* @param pageSize - Number of products per page (default: 10)
7274
* @returns Promise that resolves to an array of Product objects with their 5 most recent reviews
73-
*
75+
*
7476
* @example
7577
* const products = await getByCategoryName(5, 2, 20);
7678
* // Returns: [{id: 1, name: "Product 1", categoryId: 5, reviews: [...5 recent reviews]}, ...]
77-
*
79+
*
7880
* @throws {PrismaClientKnownRequestError} If database query fails
7981
* @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}
8082
*/

content/copilot/example-prompts-for-github-copilot-chat/functionality-analysis-and-feature-suggestions/analyzing-and-incorporating-user-feedback.md renamed to content/copilot/copilot-chat-cookbook/functionality-analysis-and-feature-suggestions/analyzing-and-incorporating-user-feedback.md

Lines changed: 2 additions & 0 deletions

0 commit comments

Comments
 (0)