Skip to content

[v2] docs(how): fix inconsistent indentation#4733

Merged
leaanthony merged 2 commits into
wailsapp:masterfrom
agilgur5:fix-v2-how-indentation
Nov 25, 2025
Merged

[v2] docs(how): fix inconsistent indentation#4733
leaanthony merged 2 commits into
wailsapp:masterfrom
agilgur5:fix-v2-how-indentation

Conversation

@agilgur5

@agilgur5 agilgur5 commented Nov 23, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

  • several places had mixed indentation (tabs and spaces)
  • some lines had incorrect indentation, partially due to the above (rendering differences between tabs and spaces)
See screenshots of what it looked like before and after these changes
Before After
Screenshot 2025-11-23 at 4 37 45 PM Screenshot 2025-11-23 at 4 37 55 PM
before - Screenshot 2025-11-23 at 4 32 49 PM after - Screenshot 2025-11-23 at 4 36 28 PM

Similar to #4730, but for a different docs page I had looked through

Fixes #N/A

Type of change

Please select the option that is relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Ran the local docs server with npm start

  • Windows
  • macOS
  • Linux

Test Configuration

N/A - docs-only change

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • [n/a] I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • [n/a] I have added tests that prove my fix is effective or that my feature works
  • [n/a] New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Improved formatting and presentation of code examples and explanatory snippets for clearer readability (spacing, indentation, and whitespace).
  • Chores
    • Updated release notes to record this documentation formatting fix under the unreleased changelog.

✏️ Tip: You can customize this high-level summary in your review settings.

@agilgur5
[v2] docs(how): fix inconsistent indentation
7c50d9e 
- several places had mixed indentation (tabs _and_ spaces)
- some lines had incorrect indentation, partially due to the above
@coderabbitai

coderabbitai Bot commented Nov 23, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Cosmetic formatting and indentation adjustments in documentation files: Go code blocks and example snippets had whitespace and tab-to-space normalization. No code logic, control flow, function signatures, or behavior were changed.

Changes

Cohort / File(s) Change Summary
Documentation Formatting
website/docs/howdoesitwork.mdx		 Normalized indentation and whitespace in Go code examples; converted tabs to spaces and adjusted formatting within code blocks.
Changelog Update
website/src/pages/changelog.mdx		 Added a new "Fixed" entry under Unreleased documenting the indentation fix to the "How does it work?" page (documentation-only change).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Purely cosmetic documentation edits across two files.
  • No functional, API, or behavioral changes to review.

Possibly related PRs

Poem

🐰 I hopped through lines of space and tab,
I straightened rows with gentle grab.
Indents now hum a tidy tune,
Docs gleam beneath the quiet moon. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: fixing inconsistent indentation in the 'how does it work' documentation page, which matches the changeset.
Description check ✅ Passed The description addresses the core issue with clear explanations and visual evidence, but does not reference a linked issue number as required by the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c50d9e and c3c180e.

📒 Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
🔇 Additional comments (1)
website/src/pages/changelog.mdx (1)

17-20: The original review comment is incorrect.

Verification confirms that website/docs/howdoesitwork.mdx was not modified in this PR. The only changed file is website/src/pages/changelog.mdx, which adds a changelog entry documenting a fix from PR #4733.

The original review comment incorrectly assumes that the indentation fixes to howdoesitwork.mdx are part of this PR and requests verification of changes that don't exist here. The actual indentation work was completed in a separate PR (#4733); this PR only adds the changelog documentation for that prior fix.

The changelog entry itself is correctly formatted and consistent with other entries in the file.

Likely an incorrect or invalid review comment.

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.

@sonarqubecloud

sonarqubecloud Bot commented Nov 23, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@leaanthony leaanthony enabled auto-merge (squash) November 25, 2025 10:15
@leaanthony leaanthony merged commit 9578b62 into wailsapp:master Nov 25, 2025
20 of 23 checks passed
@agilgur5 agilgur5 deleted the fix-v2-how-indentation branch November 25, 2025 18:18
@coderabbitai coderabbitai Bot mentioned this pull request Jan 25, 2026
Merged
15 tasks
@BrewTestBot BrewTestBot mentioned this pull request Mar 26, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leaanthony leaanthony leaanthony approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@agilgur5 @leaanthony