Skip to content

docs: fix ASCII diagram alignment in README - #3

Merged
psimaker merged 1 commit into
mainfrom
psimaker-patch-1
May 9, 2026
Merged

docs: fix ASCII diagram alignment in README#3
psimaker merged 1 commit into
mainfrom
psimaker-patch-1

Conversation

@psimaker

@psimaker psimaker commented May 9, 2026

Copy link
Copy Markdown
Owner

Cosmetic fix: trailing spaces inside the architecture diagram boxes now line up the right border. No functional change.

Documentation

Fixed spacing and alignment in the "How it works" ASCII diagram in README.md. Trailing spaces within the architecture diagram boxes now properly align the right borders, improving visual consistency of the diagram.

This is a purely cosmetic change with no impact on functionality or behavior.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 9, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a9738a0b-0b92-47a2-bbdb-7c3b2686a492

📥 Commits

Reviewing files that changed from the base of the PR and between fa6eeb8 and 2a9503a.

📒 Files selected for processing (1)
  • README.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Go Tests
🧰 Additional context used
📓 Path-based instructions (2)
**/*

⚙️ CodeRabbit configuration file

**/*: VaultSync syncs private Obsidian notes through Syncthing. Treat data loss,
privacy leaks, security regressions, and broken sync behavior as high priority.
Do not nitpick formatting unless it affects maintainability, correctness, or public API clarity.
Flag any accidental logging, telemetry, crash reporting, or network transfer of note contents,
vault paths, filenames with private context, API keys, APNs tokens, relay keys, or security-scoped bookmark data.

Files:

  • README.md
**/*.md

⚙️ CodeRabbit configuration file

**/*.md: Review public documentation for technical accuracy, privacy/security claims, App Store-facing wording,
setup correctness, and consistency with the free app plus optional Cloud Relay subscription model.

Files:

  • README.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: psimaker/vaultsync

Timestamp: 2026-05-09T11:03:55.825Z
Learning: Use Conventional Commits for commit messages
Learnt from: CR
Repo: psimaker/vaultsync

Timestamp: 2026-05-09T11:03:55.825Z
Learning: Provide clear PR descriptions in pull requests
Learnt from: CR
Repo: psimaker/vaultsync

Timestamp: 2026-05-09T11:03:55.825Z
Learning: Design the iOS app for explicit background execution limits rather than claiming always-on daemon capability
🔇 Additional comments (1)
README.md (1)

183-189: ASCII diagram alignment update looks good.

This keeps the architecture description intact and improves readability without changing behavior or claims.


📝 Walkthrough

Walkthrough

The README ASCII diagram showing the VaultSync synchronization flow between desktop/server and iOS components has been reformatted for improved alignment and readability. Connection lines and protocol label spacing were adjusted, with no changes to the functional documentation content.

Changes

Documentation Formatting

Layer / File(s) Summary
ASCII Diagram Alignment
README.md
Connection flow lines and Syncthing protocol box text spacing adjusted for visual consistency in the "How it works" diagram.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

Boxes and lines, they danced out of place,
Spacing and dashes now find their grace,
A diagram straightened with gentle care,
README now breathing with freshened air.

🚥 Pre-merge checks | ✅ 7
✅ Passed checks (7 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title uses conventional-commit format (docs:) and accurately describes the main change: fixing ASCII diagram alignment in the README.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No Private Note Leakage ✅ Passed PR modifies only README.md (ASCII diagram alignment). No code changes, no logging, analytics, or network requests introduced. Check is not applicable and passes by default.
Bounded Ios Background Work ✅ Passed PR contains only README.md documentation changes (ASCII diagram spacing alignment). No Swift code or background execution changes present. Check not applicable to this documentation-only PR.
Bridge Contract Compatibility ✅ Passed PR contains only README.md documentation changes (ASCII diagram alignment). No Go bridge or Swift bridge-service code was modified. Bridge contract compatibility is not affected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch psimaker-patch-1

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

@psimaker
psimaker merged commit b6caea8 into main May 9, 2026
6 checks passed
@psimaker
psimaker deleted the psimaker-patch-1 branch May 9, 2026 11:13
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