Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds contributor guidance to both the documentation site and repository root, and updates a few dependencies.
Changes:
- Add “Contributing” sections/links to README and docs landing page, plus a new contributing guide page in docs and root.
- Add Contributing nav entry in the docs site config.
- Update dependencies (Ruby
addressableoverride for docs site; Pythonrequestsversion bumps for external tools).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.md | Adds a Contributing section/link to the docs landing page. |
| docs/contributing.md | Introduces a docs-site Contributing guide with workflow and local dev instructions. |
| docs/_config.yml | Adds “Contributing” to the docs navigation menu. |
| docs/Gemfile.lock | Updates addressable resolution and adds it to explicit dependencies in lock. |
| docs/Gemfile | Pins/overrides addressable version for security. |
| application/external_apps/databaseseeder/requirements.txt | Bumps requests version. |
| application/external_apps/bulkloader/requirements.txt | Bumps requests version. |
| README.md | Adds a Contributing section linking to root CONTRIBUTING.md. |
| CONTRIBUTING.md | Adds a root contribution guide. |
|
|
||
| ## Contributing | ||
|
|
||
| If you want to contribute code, documentation, or fixes to Simple Chat, see the [Contributing guide](./contributing.md) for the fork workflow, target branch guidance, pull request expectations, and local development references. |
There was a problem hiding this comment.
The docs landing page links to ./contributing.md, but the contributing page is configured with permalink: /contributing/ and is also referenced in navigation via /contributing/. To avoid a broken link in the generated site (pretty URLs), link to /contributing/ (or use the site’s baseurl-aware linking convention) instead of the source .md file.
| If you want to contribute code, documentation, or fixes to Simple Chat, see the [Contributing guide](./contributing.md) for the fork workflow, target branch guidance, pull request expectations, and local development references. | |
| If you want to contribute code, documentation, or fixes to Simple Chat, see the [Contributing guide](/contributing/) for the fork workflow, target branch guidance, pull request expectations, and local development references. |
|
|
||
| # Contributing to Simple Chat | ||
|
|
||
| This page mirrors the repository root contribution guide and should stay aligned with the root `CONTRIBUTING.md` file. |
There was a problem hiding this comment.
Two issues here: (1) The page claims it mirrors root CONTRIBUTING.md, but the referenced links differ from the root guide (so it’s not actually mirrored). Either align the content/links with CONTRIBUTING.md or soften the statement. (2) The three links use relative .md paths; with Jekyll permalinks these often won’t resolve as expected in the built site. Prefer the site URLs (e.g., /setup_instructions/, /setup_instructions_manual/, and the appropriate /explanation/.../ permalink) or the repo’s standard link helpers.
| This page mirrors the repository root contribution guide and should stay aligned with the root `CONTRIBUTING.md` file. | |
| This page summarizes the repository root contribution guide and should remain consistent with the root `CONTRIBUTING.md` file. |
| - [Setup Instructions](./setup_instructions.md) | ||
| - [Manual Setup](./setup_instructions_manual.md) | ||
| - [Running Simple Chat Locally](./explanation/running_simplechat_locally.md) |
There was a problem hiding this comment.
Two issues here: (1) The page claims it mirrors root CONTRIBUTING.md, but the referenced links differ from the root guide (so it’s not actually mirrored). Either align the content/links with CONTRIBUTING.md or soften the statement. (2) The three links use relative .md paths; with Jekyll permalinks these often won’t resolve as expected in the built site. Prefer the site URLs (e.g., /setup_instructions/, /setup_instructions_manual/, and the appropriate /explanation/.../ permalink) or the repo’s standard link helpers.
| gem "json", ">= 2.19.2" | ||
|
|
||
| # Security override for transitive GitHub Pages/Jekyll dependency | ||
| gem "addressable", ">= 2.9.0" |
There was a problem hiding this comment.
Using only >= 2.9.0 can allow Bundler to resolve to a future major version of addressable that may introduce breaking changes and/or conflict with github-pages constraints. Consider constraining to the intended major series (e.g., ~> 2.9 or >= 2.9.0, < 3.0) while still addressing the security concern.
| gem "addressable", ">= 2.9.0" | |
| gem "addressable", ">= 2.9.0", "< 3.0" |
No description provided.