Skip to content

docs: Document versions in README.md#130

Merged
limakzi merged 4 commits intomainfrom
129-the-readmemd-file-should-contain-some-details-of-what-is-installed-in-each-of-the-bare-slim-and-full
May 6, 2026
Merged

docs: Document versions in README.md#130
limakzi merged 4 commits intomainfrom
129-the-readmemd-file-should-contain-some-details-of-what-is-installed-in-each-of-the-bare-slim-and-full

Conversation

@limakzi
Copy link
Copy Markdown
Member

@limakzi limakzi commented Mar 23, 2026

No description provided.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project README to reflect current GAP Docker image tags and to document what’s included in each image variant so users can choose the right one.

Changes:

  • Bumped referenced image tags in the Mermaid diagram and usage examples to newer GAP versions.
  • Added descriptions for bare, slim, full, jupyter-gap, and buildfull (with an Ubuntu 22.04 LTS footnote).
  • Expanded the README structure with a clearer “Usage” section.
Comments suppressed due to low confidence (1)

README.md:55

  • This docker run example is a duplicate of the preceding 4.14.0-bare command. It looks like one of these blocks was meant to demonstrate a different tag (e.g., slim) or a different version; please remove the duplicate or replace it with the intended example, and consider adding a short note explaining why the examples use different versions (4.15.1, 4.15.0, 4.14.0).

docker run -it ghcr.io/gap-system/gap:4.14.0-bare


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
@limakzi limakzi changed the title 129 the readmemd file should contain some details of what is installed in each of the bare slim and full docs: Document versions in README.md Mar 23, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

README.md:55

  • The Usage section currently repeats the exact same docker run ...:4.14.0-bare example twice, which looks accidental and may confuse readers. Consider removing the duplicate block or replacing it with an example for a different tag/variant (e.g., slim or jupyter-gap).

docker run -it ghcr.io/gap-system/gap:4.14.0-bare


docker run -it ghcr.io/gap-system/gap:4.14.0-bare


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Copy link
Copy Markdown
Contributor

@james-d-mitchell james-d-mitchell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @limakzi, looks good modulo one comment

Comment thread README.md Outdated
@limakzi limakzi requested a review from james-d-mitchell May 5, 2026 15:39
@limakzi limakzi merged commit 2f82376 into main May 6, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The README.md file should contain some details of what is installed in each of the bare, slim, and full

3 participants