Skip to content

Commit 9aedd5a

Browse files
committed
docs: add host docs for pr, issue and notification sections
1 parent 2799479 commit 9aedd5a

File tree

3 files changed

+78
-0
lines changed

3 files changed

+78
-0
lines changed

docs/src/content/docs/configuration/issue-section.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ title: Issue Sections
77
Defines a section in the dashboard's issues view.
88

99
- Every section must define a [`title`] and [`filters`].
10+
- When you define [`host`] for a section, that section fetches data from that GitHub host.
1011
- When you define [`limit`] for a section, that value overrides the
1112
[`defaults.issuesLimit`] setting.
1213
- When you define [`layout`] for a section, that value overrides the
1314
[`defaults.layout.issue`] setting.
1415

1516
[`title`]: #issues-title-title
1617
[`filters`]: #issues-filters-filters
18+
[`host`]: #github-host-host
1719
[`limit`]: #issues-fetch-limit-limit
1820
[`layout`]: #issues-section-layout-layout
1921
[`defaults.issuesLimit`]: /configuration/defaults/#issue-fetch-limit-issueslimit
@@ -50,6 +52,30 @@ For more information about writing filters for searching GitHub, see [Searching]
5052
5153
[Searching]: /configuration/searching
5254
55+
## GitHub Host (`host`)
56+
57+
| Type | Default |
58+
| :----- | :------ |
59+
| String | (empty) |
60+
61+
This setting specifies the GitHub host for this section. Use this when you need to fetch
62+
issues from a GitHub Enterprise instance or a different GitHub host.
63+
64+
When not specified or empty, the section uses the default GitHub host (github.com or the
65+
host configured in your `gh` CLI).
66+
67+
### Example
68+
69+
```yaml
70+
issuesSections:
71+
- title: Enterprise Issues
72+
filters: is:open author:@me
73+
host: github.enterprise.com
74+
- title: GitHub.com Issues
75+
filters: is:open author:@me
76+
# no host = default (github.com)
77+
```
78+
5379
## Issues Section Layout (`layout`)
5480

5581
You can define how a Issues section displays items in its table by setting options for the

docs/src/content/docs/configuration/notification-section.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ title: Notification Sections
77
Defines sections in the dashboard's Notifications view.
88

99
- Every section must define a [`title`] and [`filters`].
10+
- When you define [`host`] for a section, that section fetches data from that GitHub host.
1011
- When you define [`limit`] for a section, that value overrides the
1112
[`defaults.notificationsLimit`] setting.
1213

1314
[`title`]: #notification-title-title
1415
[`filters`]: #notification-filters-filters
16+
[`host`]: #github-host-host
1517
[`limit`]: #notification-fetch-limit-limit
1618
[`defaults.notificationsLimit`]: /configuration/defaults/#notifications-fetch-limit-notificationslimit
1719

@@ -116,6 +118,30 @@ This setting defines the filters for notifications in the section's table. Notif
116118
- **Explicit `is:unread`**: Shows only unread notifications, excluding bookmarked read notifications
117119
- **Reason filters**: Applied client-side after fetching from GitHub's API
118120

121+
## GitHub Host (`host`)
122+
123+
| Type | Default |
124+
| :----- | :------ |
125+
| String | (empty) |
126+
127+
This setting specifies the GitHub host for this section. Use this when you need to fetch
128+
notifications from a GitHub Enterprise instance or a different GitHub host.
129+
130+
When not specified or empty, the section uses the default GitHub host (github.com or the
131+
host configured in your `gh` CLI).
132+
133+
### Example
134+
135+
```yaml
136+
notificationsSections:
137+
- title: Enterprise Notifications
138+
filters: ""
139+
host: github.enterprise.com
140+
- title: GitHub.com Notifications
141+
filters: ""
142+
# no host = default (github.com)
143+
```
144+
119145
## Notification Fetch Limit (`limit`)
120146

121147
| Type | Minimum | Default |

docs/src/content/docs/configuration/pr-section.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ title: PR Sections
77
Defines a section in the dashboard's PRs view.
88

99
- Every section must define a [`title`] and [`filters`].
10+
- When you define [`host`] for a section, that section fetches data from that GitHub host.
1011
- When you define [`limit`] for a section, that value overrides the
1112
[`defaults.prsLimit`] setting.
1213
- When you define [`layout`] for a section, that value overrides the
1314
[`defaults.layout.pr`] setting.
1415

1516
[`title`]: #pr-title-title
1617
[`filters`]: #pr-filters-filters
18+
[`host`]: #github-host-host
1719
[`limit`]: #pr-fetch-limit-limit
1820
[`layout`]: #pr-section-layout-layout
1921
[`defaults.prsLimit`]: /configuration/defaults/#pr-fetch-limit
@@ -50,6 +52,30 @@ For more information about writing filters for searching GitHub, see [Searching]
5052
5153
[Searching]: /configuration/searching
5254
55+
## GitHub Host (`host`)
56+
57+
| Type | Default |
58+
| :----- | :------ |
59+
| String | (empty) |
60+
61+
This setting specifies the GitHub host for this section. Use this when you need to fetch
62+
PRs from a GitHub Enterprise instance or a different GitHub host.
63+
64+
When not specified or empty, the section uses the default GitHub host (github.com or the
65+
host configured in your `gh` CLI).
66+
67+
### Example
68+
69+
```yaml
70+
prSections:
71+
- title: Enterprise PRs
72+
filters: is:open author:@me
73+
host: github.enterprise.com
74+
- title: GitHub.com PRs
75+
filters: is:open author:@me
76+
# no host = default (github.com)
77+
```
78+
5379
## PR Section Layout (`layout`)
5480

5581
You can define how a PR section displays items in its table by setting options for the

0 commit comments

Comments
 (0)