Repository navigation
Commit 6ccfd2f
authored
docs: lead the homepage with the GitHub App (#59)
Before: the homepage's main button opened the Action guide, and the
"Where it runs" cards highlighted the Action ("Most teams start here").
The Team plan card linked the App repository, which is private, so
visitors got a 404. The AI attribution article and Getting started never
pointed GitHub users at the App first.
After: the main button installs the GitHub App, and the App takes the
highlighted middle card ("Fastest to set up"); the Action keeps its card
next to it. The Team card links the App guide's Plans section and says
what that section already says: until the plan launches, the App checks
an organization's private repositories at no charge. The article and
Getting started point GitHub users at the App before the CLI setup.
The App installs today from https://github.com/apps/commit-check, so the
site should send GitHub visitors there first.
| | Before | After |
|---|---|---|
| Hero button | "Add to GitHub Actions", opens the Action guide |
"Install the GitHub App", opens github.com/apps/commit-check |
| Where it runs | Action in the highlighted middle card, "Most teams
start here" | App in the highlighted middle card, "Fastest to set up";
Action unflagged next to it |
| Team plan card | "Until then, the Action covers private repositories
for free." Link: the private App repository (404) | "Until it launches,
the App checks them at no charge." Link: the App guide's Plans section |
| AI attribution article | Goes straight to the `pip install` try-out |
A paragraph first: install the App, commit a `cchk.toml` that sets
`ai_attribution`; free for public repositories and personal accounts |
| Getting started | No mention of the App before the CLI setup | A tip,
"On GitHub and want nothing to install?", with the install link |
| `docs/example.md` | "cannot move the terminal's cursor" | "cannot send
control sequences to the terminal" (CodeRabbit's note on #58: newline
and tab still move the cursor) |
How: text and link changes only, in `docs/index.md`, the article,
`docs/getting-started.md` and `docs/example.md`. `mkdocs build --strict`
and `pytest tests/` pass locally, and the built App guide has the
`#plans` anchor the Team card links to.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Updated setup guidance to recommend the GitHub App for checks on
pushes and pull requests without maintaining a workflow file.
- Clarified differences between GitHub App, CLI, and hook-based setup
options.
- Added guidance on trying disclosure policies locally.
- Documented that commit-message lines beginning with `::` are escaped
to prevent control sequences and workflow commands.
- Updated integration and pricing information, including App coverage
for organizational private repositories.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>1 parent de4ba0e commit 6ccfd2f
4 files changed
Lines changed: 31 additions & 15 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
141 | 141 | | |
142 | 142 | | |
143 | 143 | | |
144 | | - | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
145 | 153 | | |
146 | 154 | | |
147 | 155 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
239 | 239 | | |
240 | 240 | | |
241 | 241 | | |
242 | | - | |
243 | | - | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
244 | 245 | | |
245 | 246 | | |
246 | 247 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
8 | 15 | | |
9 | 16 | | |
10 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
| 37 | + | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| |||
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
| 105 | + | |
115 | 106 | | |
| 107 | + | |
116 | 108 | | |
117 | 109 | | |
118 | 110 | | |
119 | 111 | | |
120 | 112 | | |
121 | 113 | | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
| |||
442 | 442 | | |
443 | 443 | | |
444 | 444 | | |
445 | | - | |
| 445 | + | |
446 | 446 | | |
447 | 447 | | |
448 | 448 | | |
| |||
0 commit comments