chore: add merge commit to handle merge conflicts when we merge into main (all-contributors#929)

lwasser · dependabot[bot] · JimMadge · lwasser · commit 6c7799fd3fee · 2025-09-23T18:27:22.000-06:00
* chore(ci): add dependabot config for actions (all-contributors#865) * chore(ci): bump actions/checkout from 3 to 5 (all-contributors#883) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/setup-node from 3 to 4 (all-contributors#882) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v3...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/upload-pages-artifact from 3 to 4 (all-contributors#881) * chore(ci): bump actions/upload-pages-artifact from 3 to 4 Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](actions/upload-pages-artifact@v3...v4) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <leah@pyopensci.org> * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (all-contributors#890) chore(rename master to main branch): we renamed the master branch; this updates all actions & docs * docs: ✏️ fix links to doc site and small bug in footer.js (all-contributors#871) * docs: ✏️ fix links to doc site and small bug in footer.js This change fixes an error in the footer and also updates some broken links. ✅ Closes: 870 * Update website/static/index.html Co-authored-by: Leah Wasser <leah@pyopensci.org> * Update docs/overview.md --------- Co-authored-by: Jim Madge <jim+github@jmadge.com> * docs: add JimMadge as a contributor for review (all-contributors#892) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <leah@pyopensci.org> * docs: add JHWelch as a contributor for doc (all-contributors#894) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for review (all-contributors#897) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for infra (all-contributors#896) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim@jmadge.com> * docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * docs: add RichLewis007 as a contributor for bug, and doc (all-contributors#906) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add parthamk as a contributor for doc (all-contributors#909) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add rebeccaringuette as a contributor for ideas (all-contributors#910) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Change build branch from 'master' to 'docs-upgrade' * docs: add description for Ideas, projectManagement and promotion (all-contributors#829) * docs: add KhushiPandey8 as a contributor for doc (all-contributors#918) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for doc (all-contributors#921) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for doc (all-contributors#922) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: linting fix * docs: remove last docusaurus files * docs: update * chore: fix linting step to handle mdx * chore: lint * fix: links --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jordan Welch <JordanHWelch@gmail.com> Co-authored-by: Reshama Shaikh <reshama.stat@gmail.com>
diff --git a/package.json b/package.json
@@ -16,7 +16,8 @@
     "astro": "astro",
     "link-check-md": "lychee src/content/docs/**/*.md --root-dir $(pwd)/public",
     "link-check-md-offline": "lychee src/content/docs/**/*.md --root-dir $(pwd)/public --offline",
-    "lint": "markdownlint **/*.md --ignore node_modules"
+    "lint": "markdownlint **/*.{md,mdx} --ignore node_modules",
+    "lint-fix": "markdownlint **/*.{md,mdx} --ignore node_modules --fix"
   },
   "dependencies": {
     "@astrojs/sitemap": "^3.5.1",
diff --git a/src/content/docs/bot/configuration.md b/src/content/docs/bot/configuration.md
@@ -21,7 +21,7 @@ These are the keys you can specify:
 | `files`                          | Array of files to update.                                                                           | Default: `['README.md']`                                                                                    |
 | `imageSize`                      | Size (in px) of the user's avatar.                                                                  | Default: `100`                                                                                              |
 | `commit`                         | Auto-commit badge when adding contributors.                                                         | Default: `false`                                                                                           |
-| `commitConvention`               | Commit convention ([`angular`](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-guidelines), [`atom`](https://github.com/atom/atom/blob/main/CONTRIBUTING.md#git-commit-messages), [`ember`](https://guides.emberjs.com/v1.10.0/contributing/#toc_commits), [`eslint`](https://eslint.org/docs/1.0.0/developer-guide/contributing#step-2-make-your-changes), [`jshint`](https://jshint.com/contribute/), [`gitmoji`](https://gitmoji.carloscuesta.me/), or `none`).                                                         | Default: `angular`                                                                                           |
+| `commitConvention`               | Commit convention ([`angular`](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit), [`atom`](https://github.com/atom/atom/blob/main/CONTRIBUTING.md#git-commit-messages), [`ember`](https://guides.emberjs.com/v1.10.0/contributing/#toc_commits), [`eslint`](https://eslint.org/docs/latest/contribute/pull-requests#step2), [`jshint`](https://jshint.com/contribute/), [`gitmoji`](https://gitmoji.carloscuesta.me/), or `none`).                                                         | Default: `angular`                                                                                           |
 | `contributorsPerLine`            | Maximum number of columns for the contributors table.                                               | Default: `7`                                                                                                |
 | `contributorsSortAlphabetically` | `true`: Sort alphabetically. `false`: Display in order of addition.                       | Default: `false`                                                                                            |
 | `badgeTemplate`                  | Define your own lodash template to generate the badge.                                              | |
diff --git a/src/content/docs/bot/installation.mdx b/src/content/docs/bot/installation.mdx
@@ -45,10 +45,9 @@ For the list:
 
 <Aside type="caution"> The extra line is to allow the bot to properly add contributors to that block in your README file.</Aside>
 
-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. 
+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 — visit [shields.io](https://shields.io/) to make a custom badge.
 
-
 ```markdown
 [![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
 ```
diff --git a/src/content/docs/bot/overview.mdx b/src/content/docs/bot/overview.mdx
@@ -16,9 +16,9 @@ import botUsage from '@assets/bot-usage.png';
 
 Implementing the [All Contributors spec](/specification) by hand is a laborious process.
 
-The `@all-contributors bot` makes adding contributors for contributions of all kinds easy! 
+The `@all-contributors bot` makes adding contributors for contributions of all kinds easy!
 
-1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution. 
+1. First, you call the bot in any github issu or pull request and ask them to add a user for a specific contribution.
 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.
 
 <Picture src={botUsage} formats={['avif', 'webp']} alt="A screenshot of a github comment that says please add @user for design." />
diff --git a/src/content/docs/bot/usage.mdx b/src/content/docs/bot/usage.mdx
@@ -41,12 +41,12 @@ The bot will then create a Pull Request to add the contributor, then reply with
 
 <Picture src={botUsage} alt="Example usage screenshot" />
 
-### Natural Language Processing 
+### Natural Language Processing
 
 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.
 > For example, this will work too:
 >
 > `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`
 >
 
-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.
+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.
diff --git a/src/content/docs/cli/configuration.md b/src/content/docs/cli/configuration.md
@@ -4,4 +4,4 @@ title: CLI Configuration
 sidebar_label: Configuration
 ---
 
-Please refer to the  [bot documentation for CLI configuration information](../../bot/configuration).
+Please refer to the  [bot documentation for CLI configuration information](../bot/configuration).
diff --git a/src/content/docs/cli/installation.mdx b/src/content/docs/cli/installation.mdx
@@ -11,7 +11,7 @@ import { Aside } from '@astrojs/starlight/components';
 ## 1. How to Install the All-Contributors CLI tool
 
 The all-contributors CLI module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and
-should be installed as one of your project's `devDependencies`. 
+should be installed as one of your project's `devDependencies`.
 
 To install it run:
 
diff --git a/src/content/docs/cli/overview.md b/src/content/docs/cli/overview.md
@@ -12,8 +12,9 @@ sidebar_label: Overview
 The all-contributors-cli is a tool that helps you automate adding contributor acknowledgements for your GitHub or GitLab repository at the command line. THe GitHub bot allows you to call our bot in a issue or pull request.
 
 You want to use the command line because:
-- You want to add contributors in bulk
-- You want to add contributors as part of your project scripts
-- You want to add contributors as part of your continuous integration (CI) process
+
+* You want to add contributors in bulk
+* You want to add contributors as part of your project scripts
+* You want to add contributors as part of your continuous integration (CI) process
 
 Similar to the bot, the CLI allows you to implement the [All Contributors](../specification) spec, without maintaining the contributor table by hand.
diff --git a/src/content/docs/cli/usage.mdx b/src/content/docs/cli/usage.mdx
@@ -7,23 +7,24 @@ import { Aside } from '@astrojs/starlight/components';
 
 <Aside type="tip"> This usage documentation assumes you have already followed the [cli installation steps](installation). Below you will learn how to use the CLI with the `all-contributors` command, to keep things simple. If you are having any difficulties running the command on it's own, then give the `npx all-contributors-cli init` route a try 😺.</Aside>
 
-
 ## All-Contributors Command Line Interface Commands
 
 ### `all-contributors init`
 
 You can run `all-contributors init` when you first start using the All-Contributors CLI. This command asks a you few questions. It then, sets up the project to support All-Contributors.
 
-The setup includes creating: 
-* an `.all-contributorsrc` configuration file and 
+The setup includes creating:
+
+* an `.all-contributorsrc` configuration file and
 * a contributor table in the `files` you specify.
 
 The default file for the contributor table is your `README.md`.
 
 ### `all-contributors add`
 
 Use the `add` command to add:
-* new contributors to your project, or 
+
+* new contributors to your project, or
 * add new ways in which they have contributed.
 
 For instance, a user may have already contributed code, but after they add a documentation pull request you might want to add them for documentation too. The contributor will be added to your configuration file, and the
@@ -87,4 +88,4 @@ some commands will require you to set an environment variable named `PRIVATE_TOK
 export PRIVATE_TOKEN=your_private_token
 # set private token on Windows
 set PRIVATE_TOKEN=your_private_token
-```
+```
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
@@ -142,5 +142,3 @@ so you can focus on your project instead of managing your ReadMe.
   <img src="https://www.netlify.com/assets/badges/netlify-badge-color-accent.svg" alt="Deploys by Netlify" />
 
 </div>
-
-
diff --git a/src/content/docs/project/code-of-conduct.md b/src/content/docs/project/code-of-conduct.md
@@ -61,11 +61,9 @@ further defined and clarified by project maintainers.
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team.
 
-We are currently working on a new COC team here at All Contributors so please bare with us as we rework our documentation and governance structures. 
+We are currently working on a new COC team here at All Contributors so please bare with us as we rework our documentation and governance structures.
 
-
-All
-complaints will be reviewed and investigated and will result in a response that
+All complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality concerning the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.
diff --git a/src/content/docs/project/contribute.mdx b/src/content/docs/project/contribute.mdx
@@ -15,9 +15,13 @@ import translating from '@assets/translating-xpath.png';
 ## Help improve the all-contributors documentation!
 
 Thanks for your interest in the project!
-Pull Requests welcome for any level of improvement, from a small typo to a new section, help us make the project better
+Pull Requests are welcome for any type of improvement, from a small typo to a new section in the docs. Help us make the project better!
 
-All the source code is available at [github.com/all-contributors/all-contributors](https://github.com/all-contributors/all-contributors/tree/main/docs)
+All of the source code for the documentation is available in this repository here: [github.com/all-contributors/all-contributors](https://github.com/all-contributors/all-contributors/tree/main/docs)
+
+The all-contributors bot lives in the [app repository here:](https://github.com/all-contributors/all-contributors-bot)
+
+And the all-contributors CLI lives in the [cli repository here:](https://github.com/all-contributors/all-contributors-cli)
 
 ## Committing to an all-contributors repo
 
@@ -104,7 +108,7 @@ check those changes. To run the linter yourself locally on the documentation bef
 
 `npm run lint`
 
-You can also run it manually on specific files like this: 
+You can also run it manually on specific files like this:
 
 `markdownlint --fix "src/content/docs/contribute.md"`
 
diff --git a/src/content/docs/project/development.mdx b/src/content/docs/project/development.mdx
@@ -54,16 +54,21 @@ We use the `<Picture>` utility to add images to our documentation. This utility
 To use the `Picture` utility:
 
 1. First import the utility at the top of the `.mdx` file like this
+
   ```markdown
   import { Picture } from "astro:assets";
   ```
-2. Optionally, define an alias for your image path at the top of the MDX file.
+
+1. Optionally, define an alias for your image path at the top of the MDX file.
   You can also call it directly using a path.
   The image below has an alias of contributorsTableSmall and it's located in the assets directory of the site:
+
   ```markdown
   import contributorsTableSmall from '@assets/contributors-table-small.png';
   ```
-3. Use the `Picture` utility in your MDX page like this
+
+1. Use the `Picture` utility in your MDX page like this
+
   ```markdown
   <Picture src={contributorsTableSmall} formats={['avif', 'webp']} alt="A screenshot of github showing a comment that says please add @user for docs." />
   ```
@@ -81,7 +86,7 @@ In the config file code snippet above, you can see that Tailwind CSS is included
 Tailwind is also a required dependency for Starlight, so it is already set up and ready to use.
 
 We have also vendored a Google Font which is then applied in the global stylesheet.
-The global stylesheet is located at `src/styles/global.css`. The configuration to add 
+The global stylesheet is located at `src/styles/global.css`. The configuration to add
 these styles globally is found in the `astro.config.mjs` file.
 
 ```js
@@ -95,9 +100,9 @@ these styles globally is found in the `astro.config.mjs` file.
 
 ## Fonts
 
-The all contributors documentation site uses the Google Font **Poppins** as a 
-base font. For convenience and web page loading speed, we have vendored the font 
-have vendored the font in the `assets/fonts` directory for quicker loading and 
+The all contributors documentation site uses the Google Font **Poppins** as a
+base font. For convenience and web page loading speed, we have vendored the font
+have vendored the font in the `assets/fonts` directory for quicker loading and
 rendering times. The font is applied globally to headers in the `global.css` file.
 
 If we want to customize other font properties, we can do so in the `global.css` file.

Original file line number	Diff line number	Diff line change
`@@ -41,12 +41,12 @@ The bot will then create a Pull Request to add the contributor, then reply with`
`41`	`41`
`42`	`42`	`<Picture src={botUsage} alt="Example usage screenshot" />`
`43`	`43`
`44`		`-### Natural Language Processing`
	`44`	`+### Natural Language Processing`
`45`	`45`
`46`	`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.`
`47`	`47`	`> For example, this will work too:`
`48`	`48`	`>`
`49`	`49`	> `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`
`50`	`50`	`>`
`51`	`51`
`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.`
	`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.`
-Original file line number
+Diff line change
   <img src="https://www.netlify.com/assets/badges/netlify-badge-color-accent.svg" alt="Deploys by Netlify" />
 </div>
+-
+-