Skip to content

Commit 24cf2c5

Browse files
lwasserJimMadge
andcommitted
docs: update images and breakout links for the "bot" section of the documentation (all-contributors#919)
* docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (all-contributors#829) docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content * docs: fix links and breakouts in bot section * Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]>
1 parent 0e55398 commit 24cf2c5

File tree

6 files changed

+49
-52
lines changed

6 files changed

+49
-52
lines changed
File renamed without changes.
File renamed without changes.

src/content/docs/bot/installation.md renamed to src/content/docs/bot/installation.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
---
22
id: installation
3-
title: Bot Installation
3+
title: How to Install the Bot
44
sidebar_label: Installation
55
---
6-
6+
import { Picture } from "astro:assets";
7+
import { LinkButton } from '@astrojs/starlight/components';
8+
import { Aside } from '@astrojs/starlight/components';
9+
import installApp from '@assets/app-install.png';
10+
import configureRepo from '@assets/configure-repositories.png';
711

812
## 1. Install the AllContributors GitHub App
913

10-
[Install the GitHub App](https://github.com/apps/allcontributors/installations/new)
14+
<LinkButton href="https://github.com/apps/allcontributors/installations/new">Install the GitHub App</LinkButton>
1115

12-
<a href="https://github.com/apps/allcontributors/installations/new">
13-
<img alt="App Install Screenshot" src="/images/app-install.png" width="500px">
14-
</a>
16+
<Picture src={installApp} formats={['avif', 'webp']} alt="A screenshot of the GitHub interface that appears when you click the above install the bot button. It has a list of repositories and organizations that you have access to install the bot into." />
1517

1618
## 2. Configure your repositories
1719

18-
<img alt="Configure Repositories Screenshot" src="/images/configure-repositories.png" width="500px">
20+
<Picture src={configureRepo} formats={['avif', 'webp']} alt="A screenshot showing how to configure repositories for the AllContributors GitHub App." />
1921

2022
## 3. Create a `README.md`
2123

@@ -41,9 +43,11 @@ For the list:
4143
<!-- ALL-CONTRIBUTORS-LIST:END -->
4244
```
4345

44-
Note: Extra line is very important in order to make it work properly.
46+
<Aside type="caution"> The extra line is to allow the bot to properly add contributors to that block in your README file.</Aside>
47+
48+
For the badge use the following, replacing `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name.
49+
Style, color, and other parameters can be customized to your liking — visit [shields.io](https://shields.io/) to make a custom badge.
4550

46-
For the badge use the following, replacing `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name. Style, color, and other parameters can be customized to your liking — see <https://shields.io/>.
4751

4852
```markdown
4953
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
@@ -63,8 +67,3 @@ For the badge use the following, replacing `projectOwner` with the relevant GitH
6367
## 4. Update your Contributing documentation
6468
6569
Consider updating your `CONTRIBUTING.md` or similar with steps on how contributors can add themselves. You can even link to the [bot usage documentation](usage).
66-
67-
## What's next
68-
69-
- [Using the Bot](usage)
70-
- [Configuring the Bot](configuration)

src/content/docs/bot/overview.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

src/content/docs/bot/overview.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: overview
3+
title: Bot Overview
4+
sidebar_label: Overview
5+
---
6+
import { Picture } from "astro:assets";
7+
import botUsage from '@assets/bot-usage.png';
8+
9+
[![Bot Latest Release](https://img.shields.io/github/release/all-contributors/all-contributors-bot.svg)](https://github.com/all-contributors/app/releases)
10+
11+
[![Star on Github](https://img.shields.io/github/stars/all-contributors/all-contributors-bot.svg?style=flat-square)](https://github.com/all-contributors/all-contributors-bot/stargazers)
12+
13+
🤖 A GitHub bot to automate acknowledging contributors to your open source projects.
14+
15+
## How the Bot Works
16+
17+
Implementing the [All Contributors spec](/specification) by hand is a laborious process.
18+
19+
The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
20+
21+
1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
22+
2. Once you do this, the bot will automatically pull a user's profile image, grab the contribution type emoji, update the project README file with the new contributors and then open a Pull Request against the project.
23+
24+
<Picture src={botUsage} formats={['avif', 'webp']} alt="A screenshot of a github comment that says please add @user for design." />

src/content/docs/bot/usage.md renamed to src/content/docs/bot/usage.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
id: usage
33
title: Bot Usage
4-
sidebar_label: Usage
4+
sidebar_label: Bot Commands
55
---
6+
import { Picture } from "astro:assets";
7+
import {Aside} from '@astrojs/starlight/components';
8+
import botUsage from '@assets/bot-usage.png';
69

7-
> This usage documentation assumes you have already followed the [bot installation steps](installation).
10+
<Aside type="tip"> This usage documentation assumes you have already followed the [bot installation steps](installation).</Aside>
811

9-
## Commands
10-
11-
<AUTOGENERATED_TABLE_OF_CONTENTS>
12+
## Bot Commands
1213

1314
### `@all-contributors add`
1415

@@ -34,19 +35,18 @@ please add @<username> for <contributions>.
3435
please add @<username> for <contributions>.
3536
```
3637

37-
**\<contribution>**: See the [Emoji Key (Contribution Types Reference)](../emoji-key) for a list of valid `contribution` types.
38+
**contribution:** See the [Emoji Key (Contribution Types Reference)](/emoji-key) for a list of valid `contribution` types.
3839

3940
The bot will then create a Pull Request to add the contributor, then reply with the pull request details.
4041

41-
<img alt="Example usage screenshot" src="/images/bot-usage.png" width="500px">
42+
<Picture src={botUsage} alt="Example usage screenshot" />
43+
44+
### Natural Language Processing
4245

43-
> Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/main/lib/parse-comment.js) to determine your intent.
46+
Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/main/lib/parse-comment.js) to determine your intent.
4447
> For example, this will work too:
4548
>
4649
> `Jane you are crushing it in the documentation and your infrastructure work has been great too. Let's add @jane.doe23 for her contributions. cc @all-contributors`
4750
>
48-
> The bot will work best in parsing your comment correctly if you precede the contributor's username with @ as shown above. Otherwise, the bot may not correctly identify the user.
49-
50-
## What's next
5151
52-
- [Configuring the Bot](configuration)
52+
The bot will work best in parsing your comment correctly if you precede the contributor's username with @ as shown above. Otherwise, the bot may not correctly identify the user.

0 commit comments

Comments
 (0)