markdown · 2717 bytes Raw Blame History
View source
1 # Summary
2
3 [Introduction](./introduction.md)
4
5 # Using shithub
6
7 - [Quickstart](./user/quickstart.md)
8 - [Cloning over SSH](./user/ssh.md)
9 - [Cloning over HTTPS with a PAT](./user/https.md)
10 - [Personal access tokens](./user/personal-access-tokens.md)
11 - [Account settings](./user/account.md)
12 - [Two-factor authentication](./user/2fa.md)
13 - [GPG keys & commit signing](./user/gpg-keys.md)
14 - [Pro for personal accounts](./user/billing.md)
15 - [Issues](./user/issues.md)
16 - [Pull requests](./user/pull-requests.md)
17 - [Branch protection & reviews](./user/branch-protection.md)
18 - [Actions](./user/actions.md)
19 - [Notifications](./user/notifications.md)
20 - [Webhooks](./user/webhooks.md)
21 - [Search](./user/search.md)
22 - [Organizations & teams](./user/orgs.md)
23 - [Markdown reference](./user/markdown.md)
24
25 # API reference
26
27 - [Overview & conventions](./api/overview.md)
28 - [Authentication](./api/auth.md)
29 - [Users](./api/users.md)
30 - [GPG keys](./api/gpg-keys.md)
31 - [Organizations](./api/orgs.md)
32 - [Repositories](./api/repos.md)
33 - [Repository follow-ups (README/topics/merge-upstream)](./api/repos-followups.md)
34 - [Branches and tags](./api/branches.md)
35 - [Rulesets](./api/rulesets.md)
36 - [Repo collaborators](./api/collaborators.md)
37 - [Commits](./api/commits.md)
38 - [Contents](./api/contents.md)
39 - [Forks](./api/forks.md)
40 - [Issues](./api/issues.md)
41 - [Issue events / timeline](./api/issue-events.md)
42 - [Labels](./api/labels.md)
43 - [Pull requests](./api/pulls.md)
44 - [Status checks](./api/checks.md)
45 - [Actions workflow API](./api/actions.md)
46 - [Actions workflows (list/dispatch)](./api/actions-workflows.md)
47 - [Actions lifecycle (enable/disable + run delete + artifacts + job logs)](./api/actions-lifecycle.md)
48 - [Actions secrets + variables](./api/actions-secrets.md)
49 - [Actions caches](./api/actions-caches.md)
50 - [Actions workflow runs](./api/actions-runs.md)
51 - [Actions runner API](./api/actions-runner.md)
52 - [Webhooks](./api/webhooks.md)
53 - [Search](./api/search.md)
54 - [Notifications](./api/notifications.md)
55 - [Watching / subscriptions](./api/watching.md)
56 - [Events / activity](./api/events.md)
57 - [Followers / following](./api/followers.md)
58 - [Stargazers / starred](./api/stargazers.md)
59 - [Admin (site-admin only)](./api/admin.md)
60
61 # Self-hosting
62
63 - [Prerequisites](./self-host/prerequisites.md)
64 - [Deploying with Ansible](./self-host/deploy.md)
65 - [Configuration reference](./self-host/configuration.md)
66 - [Backup & restore](./self-host/backup-restore.md)
67 - [Upgrades & migrations](./self-host/upgrades.md)
68 - [Troubleshooting](./self-host/troubleshooting.md)
69 - [Capacity planning](./self-host/capacity.md)
70
71 ---
72
73 [Status](./status.md)
74 [Contributing](./contributing.md)
75 [Security policy](./security.md)
76 [Changelog](./changelog.md)