Skip to content

docs: correct Figure 6 revision label#6062

Merged
rnewson merged 3 commits into
apache:mainfrom
nightcityblade:fix/issue-6060
Jul 15, 2026
Merged

docs: correct Figure 6 revision label#6062
rnewson merged 3 commits into
apache:mainfrom
nightcityblade:fix/issue-6060

Conversation

@nightcityblade

Copy link
Copy Markdown

Fixes #6060

This updates the Figure 6 diagram in the consistency docs so the lower-left write path is labeled Save with _rev1, matching the conflict scenario described in the issue.

Verification:

  • visually checked the rendered PNG after the edit

@rnewson

rnewson commented Jul 10, 2026

Copy link
Copy Markdown
Member

hm the '1' there isn't readable, it's halfway under the adjacent image.

We seem to have lost the original source files for these diagrams so perhaps it's time for an overhaul.

At @kxepal's suggestion I looked at mermaid and think we should switch all these diagrams over to that. The editable source can be checked in to the src/docs subdir and a makefile target can then convert them to PNG and/or SVG at build time.

As an example, I did the first diagram;

sequenceDiagram
    Songbird->>CouchDB: Initial backup
    CouchDB-->>Songbird: Reply with rev 1
    CouchDB->>Laptop: Restore from backup on new laptop
    Laptop->>Laptop: User edits playlist
    Laptop->>CouchDB: Send update with rev 1
    CouchDB-->>Laptop: Reply with rev 2
    Songbird->>CouchDB: Send update with rev 1
    CouchDB-->>Songbird: 409 Conflict
Loading

Is this something you'd be interested in working on?

@nightcityblade

Copy link
Copy Markdown
Author

Thanks for the context and the mermaid example. I’m interested in that broader conversion, but it’s a different scope than this one-line label fix, so I don’t want to quietly expand this PR into a docs overhaul. I’ll leave this PR as-is and can open a separate follow-up for the mermaid migration work instead if that would be helpful.

@rnewson

rnewson commented Jul 13, 2026

Copy link
Copy Markdown
Member

fair enough.

We can't accept this PR as-is as the _rev1 text you've added is illegible. If you would try again?

@nightcityblade

Copy link
Copy Markdown
Author

Thanks for flagging this. I updated the label in 27a2cb0 by restoring its original position and replacing only the final digit; the pixel diff is confined to a 7×13 region, so “Save with _rev1” is now fully readable without touching the adjacent CouchDB node. I also reran the docs linter with make check, and it passes.

@rnewson
rnewson merged commit 803542b into apache:main Jul 15, 2026
3 checks passed
@rnewson

rnewson commented Jul 15, 2026

Copy link
Copy Markdown
Member

thanks for the update!

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.

[Bug]: Documentation mistake

2 participants