Skip to content

chore(#128): repoint SUMMARY → changelog.md + delete detailed_changelog.md (Phase C)#322

Merged
ton77v merged 2 commits into
masterfrom
chore/128-summary-repoint-delete-detailed
Jun 12, 2026
Merged

chore(#128): repoint SUMMARY → changelog.md + delete detailed_changelog.md (Phase C)#322
ton77v merged 2 commits into
masterfrom
chore/128-summary-repoint-delete-detailed

Conversation

@ton77v

@ton77v ton77v commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Phase C of beshu-tech/ror-api#127 — finish the changelog.md collapse + GitBook repoint

Final step: point the docs nav at the single changelog.md and remove the old detailed_changelog.md.

Closes beshu-tech/ror-api#128.

🚦 GATED — merge LAST, only after Phase B is deployed. This must not merge until ror-api (beshu-tech/ror-api#126, PR beshu-tech/ror-api#129) is deployed and has rendered changelog.md to docs master — otherwise SUMMARY.md points at a file that doesn't exist yet. Order is A → B → C (see beshu-tech/ror-api#127). Phase A = #321.

Changes

  • SUMMARY.md[Changelog](detailed_changelog.md)[Changelog](changelog.md).
  • Delete detailed_changelog.md — ror-api now writes the detailed render to changelog.md (Phase B). The "rename" completes here: new name written by ror-api, old file removed.

GitBook — manual, gating (Simone)

  • Repoint the rendered changelog page from detailed_changelog.mdchangelog.md (slug /detailed_changelog/changelog; add a redirect if GitBook supports it).
  • Simone owns the GitBook account and must merge this PR once GitBook is reconfigured — add him as reviewer before marking ready.

Verification

  • After Phase B deploy: changelog.md exists on master with the generated-file disclaimer header; SUMMARY.md link resolves; docs.readonlyrest.com serves the changelog from /changelog.
  • detailed_changelog.md 404s on the raw CDN.

🦀 sent by Claude Code

…log.md

Phase C of #127 — final docs-side step of the changelog.md collapse.
- SUMMARY.md: [Changelog](detailed_changelog.md) -> [Changelog](changelog.md)
- delete detailed_changelog.md (ror-api writes the detailed render to changelog.md
  as of Phase B / #126).

Gated: merge only AFTER Phase B (#126) is deployed and has rendered changelog.md to
master — else SUMMARY points at a missing file. GitBook source flip is manual
(Simone owns the account).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 490d845f-2eaa-40ac-9eb7-c80af34b03ce

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/128-summary-repoint-delete-detailed

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ton77v

ton77v commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator Author

Phase B ready:
https://github.com/beshu-tech/ror-api/pull/129

…epoint-delete-detailed

# Conflicts:
#	detailed_changelog.md
@ton77v

ton77v commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator Author

@sscarduzio so please flip the final switch when you have time:

  1. In GitBook change the source of the CL from detailed_changelog.md to changelog.md
  2. Merge this and it's gone 😀

UPD: that was outdated info

@ton77v ton77v requested a review from sscarduzio June 12, 2026 08:50
@ton77v ton77v marked this pull request as ready for review June 12, 2026 08:50
@ton77v

ton77v commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator Author

⚠️ Read before merging — GitBook serves develop, this PR targets master

This PR repoints SUMMARY.mdchangelog.md and deletes detailed_changelog.md on master. But GitBook publishes the develop branch, and:

  • ror-api renders changelog.md to master only — changelog.md is not on develop yet (develop still has detailed_changelog.md).
  • master → develop is manual — there is no sync workflow.

Do NOT hand-edit develop's SUMMARY to changelog.md before develop has the file — GitBook would 404.

Correct order

  1. Merge this PR → master (master now has changelog.md + SUMMARY → changelog.md + no detailed_changelog.md).
  2. Advance develop to master. Right now develop is a clean ancestor of master (0 ahead / 2 behind — just the changelog.md render commits), so this is a plain fast-forward (master → develop PR / FF) — no merge branch, no conflicts. It carries changelog.md + the SUMMARY repoint + the detailed_changelog.md removal onto GitBook in one shot, with no manual SUMMARY edit.

Note: the old sync/master-into-develop branch is a stale (May-13) hand-merge — not needed for this; a fresh fast-forward is cleaner.

⚠️ There are open PRs into develop (#320, #305). If either merges first, develop diverges from master and the sync becomes a real merge (not a clean FF) — so advance develop close to when you merge this PR.

🦀 sent by Claude Code

@ton77v ton77v removed the request for review from sscarduzio June 12, 2026 09:35
@ton77v ton77v merged commit b9808ad into master Jun 12, 2026
3 checks passed
@ton77v ton77v deleted the chore/128-summary-repoint-delete-detailed branch June 12, 2026 09:45
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