Skip to content

Update versions in markdown files#7465

Open
Gared wants to merge 2 commits intodevelopfrom
update_version_doc
Open

Update versions in markdown files#7465
Gared wants to merge 2 commits intodevelopfrom
update_version_doc

Conversation

@Gared
Copy link
Copy Markdown
Member

@Gared Gared commented Apr 5, 2026

Update static version information in our markdown documentation

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

Review Summary by Qodo

Update version information in documentation files

📝 Documentation

Grey Divider

Walkthroughs

Description
• Update API version from 1.2.15 to 1.3.0 in HTTP API docs
• Update Docker image version from 1.8.0 to 2.6.1
• Synchronize version information across multiple documentation formats
Diagram
flowchart LR
  A["Documentation Files"] -->|Update API version| B["http_api.adoc: 1.2.15 → 1.3.0"]
  A -->|Update API version| C["http_api.md: 1.2.15 → 1.3.0"]
  A -->|Update Docker version| D["docker.md: 1.8.0 → 2.6.1"]
Loading

Grey Divider

File Changes

1. doc/api/http_api.adoc 📝 Documentation +1/-1

Update HTTP API version to 1.3.0

• Update API version from 1.2.15 to 1.3.0
• Maintains consistent version documentation in AsciiDoc format

doc/api/http_api.adoc


2. doc/api/http_api.md 📝 Documentation +1/-1

Update HTTP API version to 1.3.0

• Update API version from 1.2.15 to 1.3.0
• Maintains consistent version documentation in Markdown format

doc/api/http_api.md


3. doc/docker.md 📝 Documentation +1/-1

Update Docker image version to 2.6.1

• Update Docker image version from 1.8.0 to 2.6.1
• Reflects latest available etherpad Docker image version

doc/docker.md


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects bot commented Apr 5, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX Issues (0)

Grey Divider


Remediation recommended

1. Docker docs mismatch🐞 Bug ⚙ Maintainability
Description
The PR updates doc/docker.md to recommend pulling image tag 2.6.1, but the parallel AsciiDoc
doc/docker.adoc still recommends 1.8.0, resulting in conflicting installation instructions. Users
following the AsciiDoc guide will likely deploy an outdated version.
Code

doc/docker.md[12]

+docker pull etherpad/etherpad:2.6.1
Evidence
The Markdown Docker guide now instructs users to pull 2.6.1, while the AsciiDoc Docker guide still
instructs users to pull 1.8.0. The repository's current version is 2.6.1, so the AsciiDoc example is
stale and inconsistent with the updated Markdown doc.

doc/docker.md[1-14]
doc/docker.adoc[1-16]
package.json[40-54]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`doc/docker.md` was updated to reference Docker image tag `2.6.1`, but the AsciiDoc equivalent (`doc/docker.adoc`) still references `1.8.0`, creating conflicting guidance.
## Issue Context
The repository's current version is `2.6.1`, and the Markdown Docker docs already reflect that.
## Fix Focus Areas
- doc/docker.adoc[10-16]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

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.

1 participant