Skip to content

Commit 8bab43d

Browse files
authored
Merge pull request #37063 from github/repo-sync
Repo sync
2 parents c013da7 + 530edd6 commit 8bab43d

File tree

12 files changed

+135
-14
lines changed

12 files changed

+135
-14
lines changed

content/copilot/copilot-chat-cookbook/documenting-code/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ children:
1212
- /explaining-legacy-code
1313
- /explaining-complex-algorithms-or-logic
1414
- /syncing-documentation-with-code-changes
15+
- /writing-discussions-or-blog-posts
1516
---
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Writing discussions or blog posts
3+
shortTitle: Write discussions or blog posts
4+
intro: '{% data variables.product.prodname_copilot_chat_short %} can help you generate ideas, outline, or draft discussions or blog posts.'
5+
versions:
6+
feature: copilot
7+
category:
8+
- 'Documenting code'
9+
complexity:
10+
- Simple
11+
octicon: book
12+
topics:
13+
- Copilot
14+
---
15+
16+
When you're working on code, you often need to quickly create accurate and comprehensive explanations to share your work with teammates or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help by suggesting ideas, outlines, or complete drafts for discussions or blog posts—enabling you to document and communicate clearly, so you can spend more time focused on coding.
17+
18+
>[!TIP] You can include links to specific pull requests or issues in your prompts to give {% data variables.product.prodname_copilot_chat_short %} more context. If you're not getting the results you expect, try specifying the repository in your prompt to help {% data variables.product.prodname_copilot_chat_short %} focus on the right project.
19+
20+
## Generating ideas
21+
22+
When you're working on a project, you may need to write a discussion or blog post to share your ideas, get feedback, or communicate with your team. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas.
23+
24+
### Brainstorming topics from recent work
25+
26+
If you're looking for ideas for a discussion post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest topics based on your recent work.
27+
28+
#### Example prompts
29+
30+
`I’ve worked on three major PRs (#21, #27, and #44) in the last month. Could you suggest five potential blog topics that highlight the unique challenges or solutions from each PR?`
31+
32+
`We improved backend performance in PR #16 and addressed user feedback in Issues #10 and #12. What interesting blog ideas can you propose that tie these updates together for a developer audience?`
33+
34+
`We released a major version upgrade in PR #99 for our library. Could you suggest three blog angles that highlight the major changes, the lessons we learned, and how the community can benefit from it?`
35+
36+
`We’ve been working on a new AI-driven feature in PR #120. Please propose some blog post titles and short descriptions that will catch developers’ attention while explaining how this feature fits into our product roadmap.`
37+
38+
### Writing technical deep dives
39+
40+
When you're working on a complex feature or system, you may need to write a technical deep dive to share your work with your team or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for technical deep dives by suggesting topics based on your recent work.
41+
42+
#### Example prompts
43+
44+
`I just finished implementing a complex authentication flow in PR #30. Could you outline a blog post explaining the challenges we faced, the approach we took to solve them, and a brief code example highlighting key sections?`
45+
46+
`Generate a blog outline that discusses our shift to a more modular architecture in PR #55. I want to explain why we made the switch, how it impacts scalability, and any trade-offs we faced along the way.`
47+
48+
`Propose a developer-focused blog post centered on the new caching mechanism we built in PR #64. Highlight key aspects of the implementation, show code snippets, and explain the performance improvements.`
49+
50+
### Sharing best practices
51+
52+
When you're working on a project, you may need to write a discussion post to share best practices or lessons learned. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for discussion posts.
53+
54+
#### Example prompt
55+
56+
`I just finished implementing a complex authentication flow in PR #30. Could you outline a blog post explaining the challenges we faced, the approach we took to solve them, and a brief code summary highlighting best practices?`
57+
58+
## Drafting content
59+
60+
Once you have an idea for a discussion or blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you draft the content. {% data variables.product.prodname_copilot_chat_short %} can provide you with a detailed outline, a rough draft, or a polished draft, depending on your needs.
61+
62+
### Outlining a blog post
63+
64+
If you're looking for help outlining a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a detailed outline for your post.
65+
66+
#### Example prompt
67+
68+
`Please propose an outline for a blog post based on PR #16 and Issues #10 and #12. Include new features introduced, user-facing improvements, and next steps.`
69+
70+
### Drafting a blog post
71+
72+
If you're looking for help drafting a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a rough draft for your post.
73+
74+
#### Example prompts
75+
76+
`Please write a short blog post describing how we integrated a new logging module from PR #40. Highlight how it benefits users, and suggest next steps.`
77+
78+
`I’d like a draft paragraph summarizing exciting new features or important changes introduced in recent commits. Please explain clearly what changed and why it's significant for users.`
79+
80+
`Generate a brief ‘shout-out’ paragraph that highlights the contributors who submitted PRs #33 and #37, explaining their impact and thanking them for their work.`
81+
82+
## Refining your draft
83+
84+
Once you have a draft, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you refine it. {% data variables.product.prodname_copilot_chat_short %} can provide you with suggestions for improving your writing, making it more engaging, or clarifying complex concepts.
85+
86+
### Improving tone and style
87+
88+
If you're looking to improve the tone and style of your writing, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more engaging or accessible.
89+
90+
#### Example prompt
91+
92+
`Please rewrite the conclusion in a more informal, conversational style. The original conclusion was: ‘Our team successfully launched a groundbreaking update.’ Make it feel more personal and celebratory.`
93+
94+
### Including next steps
95+
96+
If you're looking to include next steps in your blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more actionable.
97+
98+
#### Example prompt
99+
100+
`Draft a final section on upcoming milestones and open issues labeled ‘enhancement.’ Show what's coming next, and mention opportunities for community engagement.`

content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-code-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ redirect_from:
1414
---
1515

1616
> [!NOTE]
17-
> * {% data variables.copilot.copilot_code-review %} is in {% data variables.release-phases.public_preview %} and subject to change. To access the {% data variables.release-phases.public_preview %}, see [Join the preview for {% data variables.copilot.copilot_code-review_short %}-powered code reviews](https://gh.io/copilot-code-review-waitlist).
17+
> * {% data variables.copilot.copilot_code-review %} is in {% data variables.release-phases.public_preview %} and subject to change.
1818
> * The [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) apply to your use of this product.
1919
2020
## About {% data variables.copilot.copilot_code-review %}

content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ redirect_from:
1212
- /early-access/copilot/code-reviews/configuring-coding-guidelines
1313
---
1414

15-
> [!NOTE] Custom coding guidelines are limited to selected participants in the {% data variables.release-phases.public_preview %} of {% data variables.copilot.copilot_code-review_short %}, and only available as part of a subscription to {% data variables.product.prodname_copilot_enterprise %}.
15+
{% data reusables.copilot.code-review.custom-coding-guidelines-prerequisites %}
1616

1717
## About coding guidelines
1818

content/copilot/using-github-copilot/code-review/using-copilot-code-review.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@ These instructions explain how to use {% data variables.copilot.copilot_code-rev
6868

6969
### Requesting a pull request review from {% data variables.product.prodname_copilot_short %}
7070

71-
> [!NOTE]
72-
> To access the {% data variables.release-phases.public_preview %} of this feature, see [Join the preview for {% data variables.copilot.copilot_code-review_short %}-powered code reviews](https://gh.io/copilot-code-review-waitlist).
73-
7471
1. On {% data variables.product.prodname_dotcom_the_website %}, create a pull request or navigate to an existing pull request.
7572
1. Open the **Reviewers** menu, then select **{% data variables.product.prodname_copilot_short %}**.
7673

@@ -156,9 +153,6 @@ You can request an initial review of a highlighted selection of code in {% data
156153

157154
### Reviewing changes
158155

159-
> [!NOTE]
160-
> To access the {% data variables.release-phases.public_preview %} of this feature, see [Join the preview for {% data variables.copilot.copilot_code-review_short %}-powered code reviews](https://gh.io/copilot-code-review-waitlist).
161-
162156
You can request a review for your staged or unstaged changes in {% data variables.product.prodname_vscode %}.
163157

164158
1. In {% data variables.product.prodname_vscode_shortname %}, switch to the **Source Control** tab.

content/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ topics:
99
- Copilot
1010
---
1111

12-
> [!NOTE] {% data variables.product.prodname_copilot_workspace %} is currently in {% data variables.release-phases.public_preview %} and is subject to change.
12+
> [!NOTE] {% data variables.product.prodname_copilot_workspace %} is currently in limited {% data variables.release-phases.public_preview %}. The waitlist for admission to this preview is currently closed.
1313
1414
## About using {% data variables.product.prodname_copilot_short %} to help you work on your pull requests
1515

@@ -40,7 +40,7 @@ After you create a pull request, you can continue working on the PR on the {% da
4040

4141
Using {% data variables.product.prodname_copilot_workspace %} requires an existing pull request on the {% data variables.product.github %} website and either of the following:
4242

43-
* Access to {% data variables.product.prodname_copilot_short %}—see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot)—and admission to the {% data variables.release-phases.public_preview %}—see [Join the preview for {% data variables.copilot.copilot_code-review_short %}-powered code reviews](https://gh.io/copilot-code-review-waitlist).
43+
* Access to this {% data variables.release-phases.public_preview %} from the waitlist (now closed).
4444
* Access to {% data variables.product.prodname_GHAS %} (GHAS) features on a private repository owned by an organization on a {% ifversion ghas-products-cloud %}{% data variables.product.prodname_team %} or {% endif %}{% data variables.product.prodname_enterprise %} plan. See [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
4545

4646
Without access to {% data variables.product.prodname_copilot_workspace %} you can still edit the files in pull requests by going to the **Files changed** tab, clicking the ellipsis (**...**) next to the file you want to edit, and then clicking **Edit file**.

content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ Community members can upvote discussions and top-level comments inside discussio
2828

2929
For more information about participation in discussions, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion).
3030

31+
{% ifversion copilot %}
32+
33+
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions, based on your pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
34+
35+
{% endif %}
36+
3137
## Prerequisites
3238

3339
To collaborate with maintainers in repository discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository).

content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ In addition to starting or viewing discussions and polls, you can:
2323

2424
{% ifversion fpt or ghec %}You can block users and report disruptive content to maintain a safe and pleasant environment for yourself. For more information, see [AUTOTITLE](/communities/maintaining-your-safety-on-github).{% endif %}
2525

26+
{% ifversion copilot %}
27+
28+
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions based on your recent pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
29+
30+
{% endif %}
31+
2632
## Prerequisites
2733

2834
{% data variables.product.prodname_discussions %} must be enabled for the repository or organization for you to participate in a discussion in the repository or organization. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository) and [AUTOTITLE](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization).

content/get-started/using-github/communicating-on-github.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ You can create and participate in issues, pull requests, {% data variables.produ
2828
You can create and participate in issues, pull requests, and team discussions, depending on the type of conversation you'd like to have.
2929
{% endif %}
3030

31+
{% ifversion copilot %}
32+
33+
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions, based on your pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
34+
35+
{% endif %}
36+
3137
### {% data variables.product.prodname_github_issues %}
3238

3339
* Are useful for discussing specific details of a project such as bug reports, planned improvements and feedback

content/issues/tracking-your-work-with-issues/about-issues.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ You can create issues in your repository to plan, discuss, and track work. Issue
2121

2222
Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion sub-issues %} while adding sub-issues,{% endif %} convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue).
2323

24+
{% ifversion copilot %}
25+
26+
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions or blog posts, based on your issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
27+
28+
{% endif %}
29+
2430
{% ifversion sub-issues %}
2531

2632
## About sub-issues

0 commit comments

Comments
 (0)