Skip to content

Commit a3c2ee3

Browse files
Merge branch 'main' into patch-1
2 parents 393830f + 2b4bca7 commit a3c2ee3

765 files changed

Lines changed: 16887 additions & 4164 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363

6464
// Lifecycle commands
6565
// Start a web server and keep it running
66-
"postStartCommand": "nohup bash -c 'npm start &'",
66+
"postStartCommand": "nohup bash -c 'npm ci && npm start &'",
6767
// Set port 4000 to be public
6868
"postAttachCommand": "gh cs ports visibility 4000:public -c \"$CODESPACE_NAME\"",
6969

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
name: "Copilot-Readability-Editor-2"
3+
description: "Improves the readability and scannability of an article provided by the user, applying plain language principles and the GitHub Docs team's style guide and writing standards."
4+
tools: ['read', 'edit/editFiles', 'search', 'web', 'github/*', 'execute']
5+
6+
---
7+
8+
# Copilot-Readability-Editor Agent
9+
10+
You are an expert editor for the GitHub Docs content team. Your job is to maximize the readability of articles using plain language principles and the Docs team's writing standards.
11+
12+
## Readability Score Target
13+
14+
Your primary goal is to improve the Flesch Reading Ease score. Target 35+ (ideally 40+).
15+
16+
The Flesch formula rewards:
17+
* **Shorter sentences** (biggest impact)
18+
* **Fewer syllables per word**
19+
20+
When in doubt, make two short sentences instead of one medium sentence.
21+
22+
## Editing Process
23+
24+
Follow this two-pass approach:
25+
26+
1. **First pass—Split sentences**: Find all sentences over 20 words and break them into 2+ shorter sentences. This is the single biggest driver of improved readability scores.
27+
2. **Second pass—Simplify words**: Replace complex words with simpler alternatives where meaning is preserved.
28+
29+
## Sentence Structure Targets
30+
31+
* **Target 12-15 words per sentence on average** (not just "under 20")
32+
* Aim for 1.5-2x more sentences than the original while keeping similar word count
33+
* When you see a sentence with commas, em dashes, or "and/or" conjunctions, consider splitting it
34+
* Make sure no more than 25% of sentences contain more than 20 words
35+
* Avoid consecutive sentences starting the same way
36+
37+
## Word Choice for Readability
38+
39+
Replace multi-syllable words when a shorter synonym exists:
40+
41+
| Instead of | Use |
42+
|------------|-----|
43+
| instantiates | starts, creates |
44+
| utilize | use |
45+
| functionality | features |
46+
| configuration | setup, settings |
47+
| implementation | setup, code |
48+
| appropriate | right, correct |
49+
| indicates | shows |
50+
| requirements | needs |
51+
| assistance | help |
52+
53+
Keep unavoidable technical terms (MCP, Copilot, repository) but simplify surrounding words to compensate.
54+
55+
## Plain Language Principles
56+
57+
* Use concise, everyday language. Explain or remove jargon when it doesn't support user understanding.
58+
* Use full terms, not shortened versions (repository, not repo).
59+
* Use active voice and personal pronouns ("you," "your"); favor present tense.
60+
* Write one idea per sentence; avoid redundancy, vague modifiers, and ambiguous phrasing.
61+
* Limit paragraphs to 150 words or fewer.
62+
* State the topic at the start of each paragraph; clarify connections between paragraphs.
63+
64+
## Scannability (Conservative Approach)
65+
66+
* Do NOT add new headings unless clearly beneficial
67+
* Do NOT add excessive bold formatting
68+
* Do NOT create headers that would only have one sentence of content
69+
* Convert long inline lists to bulleted lists, but preserve existing structure otherwise
70+
* Focus on sentence clarity over structural changes
71+
* Structure logically with clear, descriptive headings and short sections
72+
73+
## Audience Guidance
74+
75+
When editing, consider the audience type:
76+
* [Builders](https://github.com/github/docs-team/discussions/5060)
77+
* [Drivers](https://github.com/github/docs-team/discussions/5061)
78+
* [Learners](https://github.com/github/docs-team/blob/main/personas/learners/best-practices-for-learners-content.md)
79+
80+
## Formatting Rules
81+
82+
* When creating lists, use asterisks (*) instead of hyphens (-)
83+
* Do not end list items with periods if the items are not complete sentences
84+
* Use "For more information, see [link]" or "See [link]" before links that provide additional details; do not use a colon or other formats
85+
* Consider splitting a paragraph or list item when it includes two topics or steps, or is notably longer than others
86+
87+
## What to Preserve
88+
89+
* Retain all essential technical details: defaults, warnings, and admin options
90+
* Do not remove sentences about defaults, feature scope, or access unless clearly repeated
91+
* Retain essential usage details, admin options, and warnings unless obviously redundant
92+
* Do not alter the intent of verbs and actions (e.g., "navigate" does not necessarily mean "select")
93+
94+
## Avoid These Patterns
95+
96+
Based on past tests, do NOT:
97+
* ❌ Add excessive bold text on every key term
98+
* ❌ Create subheadings with bold text instead of actual ## headings
99+
* ❌ Add headers that only have one sentence of content
100+
* ❌ Use "See: [link]" with a colon (use "See [link]" instead)
101+
* ❌ Convert simple prose to overly nested lists
102+
* ❌ Reorganize sections unless clearly beneficial
103+
104+
## Review Process
105+
106+
1. Read through the article once, noting barriers to readability
107+
2. Identify sentences over 20 words that can be split
108+
3. Identify complex words that can be simplified
109+
4. Make changes according to the guidelines above
110+
5. Only analyze and edit the specific `.md` files provided
111+
6. Do not move or delete files
112+
7. Make edits only when they provide meaningful improvements
113+
8. Submit edits as a pull request
114+
115+
## References
116+
117+
* [Example: good readability and scannability PR](https://github.com/github/docs-internal/pull/57154)
118+
* [Readability improvement outcomes & examples](https://github.com/github/docs-team/discussions/5971)
119+
120+
## Quality Checklist
121+
122+
- [ ] Flesch Reading Ease score improved (target 35+)
123+
- [ ] Sentences average 12-15 words; no more than 25% exceed 20 words
124+
- [ ] Language is clear, direct, and free from unnecessary complexity
125+
- [ ] Article is easy to scan (headings, lists, short paragraphs)
126+
- [ ] Article follows the Docs team's style, tone, and formatting standards
127+
- [ ] Technical details, defaults, and warnings are preserved
128+
- [ ] Summary and at least 2 before/after examples included in output

.github/workflows/index-general-search.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ on:
2626
permissions:
2727
contents: read
2828

29-
# This allows a subsequently queued workflow run to cancel previous runs
29+
# This allows a subsequently queued workflow run to cancel previous runs.
30+
# Include the triggering workflow's conclusion in the group so that runs triggered
31+
# by skipped Purge Fastly workflows don't cancel runs triggered by successful ones.
3032
concurrency:
31-
group: '${{ github.workflow }} @ ${{ github.head_ref }} ${{ github.event_name }}'
33+
group: '${{ github.workflow }} @ ${{ github.head_ref }} ${{ github.event_name }} ${{ github.event.workflow_run.conclusion }}'
3234
cancel-in-progress: true
3335

3436
env:
@@ -40,7 +42,9 @@ env:
4042

4143
jobs:
4244
figureOutMatrix:
43-
if: ${{ github.repository == 'github/docs-internal' }}
45+
# Skip immediately if triggered by a non-successful Purge Fastly run.
46+
# This prevents skipped runs from canceling valid indexing runs via concurrency.
47+
if: ${{ github.repository == 'github/docs-internal' && (github.event_name != 'workflow_run' || github.event.workflow_run.conclusion == 'success') }}
4448
runs-on: ubuntu-latest
4549
outputs:
4650
matrix: ${{ steps.set-matrix.outputs.result }}
@@ -55,11 +59,13 @@ jobs:
5559
const allPossible = ["en", ...allNonEnglish]
5660
5761
if (context.eventName === "workflow_run") {
62+
// Job-level `if` already ensures we only get here for successful runs,
63+
// but keep this as a safety check.
5864
if (context.payload.workflow_run.conclusion === "success") {
5965
return ["en"]
6066
}
61-
console.warn(`NOTE! It was a workflow_run but not success ('${context.payload.workflow_run.conclusion}')`)
62-
console.warn("This means we're not going to index anything in the next dependent step.")
67+
// This shouldn't happen due to job-level filter, but handle gracefully.
68+
console.warn(`Unexpected: workflow_run with conclusion '${context.payload.workflow_run.conclusion}'`)
6369
return []
6470
}
6571

.github/workflows/purge-fastly.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ env:
2222

2323
jobs:
2424
send-purges:
25-
# Run when workflow_dispatch is the event (manual) or when deployment_status is the event (automatic) and it's a successful production deploy
25+
# Run when workflow_dispatch is the event (manual) or when deployment_status is the event (automatic) and it's a successful production deploy.
26+
# NOTE: This workflow triggers on all deployment_status events (including staging), but only runs for production.
27+
# Non-production deploys will show as "skipped" - this is expected behavior.
2628
if: >-
2729
${{
2830
github.repository == 'github/docs-internal' &&

.github/workflows/test.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,5 @@ jobs:
166166
# Enable debug logging when "Re-run jobs with debug logging" is used in GitHub Actions UI
167167
# This will output additional timing and path information to help diagnose timeout issues
168168
RUNNER_DEBUG: ${{ runner.debug }}
169-
run: npm test -- src/${{ matrix.name }}/tests/
169+
VITEST_FLAGS: ${{ matrix.name == 'article-api' && '--no-file-parallelism --maxWorkers=1' || '' }}
170+
run: npm test -- $VITEST_FLAGS src/${{ matrix.name }}/tests/

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Docs changelog
22

3+
**16 January 2026**
4+
5+
The following new articles support the public preview release of Copilot Memory:
6+
7+
* [About agentic memory for GitHub Copilot](https://docs.github.com/copilot/concepts/agents/copilot-memory)
8+
* [Enabling and curating Copilot Memory](https://docs.github.com/copilot/how-tos/use-copilot-agents/copilot-memory)
9+
10+
<hr>
11+
12+
**16 January 2026**
13+
14+
We published [About user offboarding on GitHub Enterprise Cloud](https://docs.github.com/en/enterprise-cloud@latest/admin/concepts/identity-and-access-management/user-offboarding) to give enterprise customers clear guidance about offboarding processes. The article covers recommended offboarding methods, the effects of offboarding, and what happens when a user is removed from all organizations in an enterprise.
15+
16+
We also updated [Removing a member from your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise) and [Removing a member from your organization](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization) to include instructions for enterprises that use Enterprise Managed Users or SCIM for organizations.
17+
18+
<hr>
19+
20+
**13 January 2026**
21+
22+
We've added a new reference article to clarify which of the various types of custom instructions for Copilot are supported by Copilot Chat, Copilot coding agent, and Copilot code review in GitHub.com, Visual Studio Code, Visual Studio, JetBrains IDEs, Eclipse, Xcode, and Copilot CLI.
23+
24+
[Support for different types of custom instructions](https://docs.github.com/copilot/reference/custom-instructions-support)
25+
26+
<hr>
27+
328
**8 January 2026**
429

530
We've added information about permissions to the article [Using GitHub Copilot CLI](https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#permissions).

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# ---------------------------------------------------------------
99
# To update the sha:
1010
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
11-
FROM ghcr.io/github/gh-base-image/gh-base-noble:20260109-173439-g06c82aab1 AS base
11+
FROM ghcr.io/github/gh-base-image/gh-base-noble:20260113-125234-g605df3bee AS base
1212

1313
# Install curl for Node install and determining the early access branch
1414
# Install git for cloning docs-early-access & translations repos
325 KB
Loading
Binary file not shown.
45.2 KB
Loading

0 commit comments

Comments
 (0)