Skip to content

Commit 03efd04

Browse files
authored
update activity intros (github#27216)
1 parent 5f78f22 commit 03efd04

File tree

4 files changed

+17
-18
lines changed

4 files changed

+17
-18
lines changed

content/rest/activity/feeds.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
---
1313

14+
## About the Feeds API
15+
16+
To see what feeds are available to you, use the [Get feeds](#get-feeds) operation. You can then get a feed by sending a request to one of the feed URLs.
17+
1418
### Example of getting an Atom feed
1519

1620
To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories:

content/rest/activity/notifications.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Notifications
3-
intro: ''
3+
intro: 'The Notifications API lets you manage {% data variables.product.product_name %} notifications.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -11,18 +11,9 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
---
1313

14-
Users receive notifications for conversations in repositories they watch including:
14+
## About the Notifications API
1515

16-
* Issues and their comments
17-
* Pull Requests and their comments
18-
* Comments on any commits
19-
20-
Notifications are also sent for conversations in unwatched repositories when the user is involved including:
21-
22-
* **@mentions**
23-
* Issue assignments
24-
* Commits the user authors or commits
25-
* Any discussion in which the user actively participates
16+
The Notifications API lets you manage {% data variables.product.product_name %} notifications. For more information about notifications, see "[About notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)."
2617

2718
All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints.
2819

@@ -44,11 +35,11 @@ $ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT"
4435
> X-Poll-Interval: 60
4536
```
4637

47-
### Notification reasons
38+
### About notification reasons
4839

4940
When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification.
5041

51-
Here's a list of potential `reason`s for receiving a notification:
42+
These are the potential `reason`s for receiving a notification:
5243

5344
Reason Name | Description
5445
------------|------------

content/rest/activity/starring.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Starring
3-
intro: 'Repository starring is a feature that lets users bookmark repositories.'
3+
intro: 'The Starring API lets you bookmark a repository.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -11,7 +11,9 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
---
1313

14-
Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed.
14+
## About the Starring API
15+
16+
The Starring API lets you bookmark a repository. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. For more information, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)."
1517

1618
### Starring vs. Watching
1719

content/rest/activity/watching.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Watching
3-
intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed."
3+
intro: "The Watching API lets users subscribe to notifications for activity in a repository."
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -11,4 +11,6 @@ topics:
1111
miniTocMaxHeadingLevel: 3
1212
---
1313

14-
For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)."
14+
## About the Watching API
15+
16+
The Watching API lets users subscribe to notifications for activity in a repository. To bookmark a repository instead, see "[Starring](/rest/reference/activity#starring)."

0 commit comments

Comments
 (0)