Skip to content

[v2] docs(app-dev): fix inconsistent indentation#4730

Merged
leaanthony merged 3 commits into
wailsapp:masterfrom
agilgur5:fix-v2-app-dev-indentation
Nov 30, 2025
Merged

[v2] docs(app-dev): fix inconsistent indentation#4730
leaanthony merged 3 commits into
wailsapp:masterfrom
agilgur5:fix-v2-app-dev-indentation

Conversation

@agilgur5

@agilgur5 agilgur5 commented Nov 23, 2025

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 3 32 35 PM Screenshot 2025-11-23 at 4 03 53 PM

Noticed while reading through and fixing some other parts of the docs

Fixes #N/A

Future Work

  • Note that some of this could be automated with gofmt and moving snippets into a separate directory and then embedding them
    • but that's a much larger change to consider
  • also I fixed leading indentation, but not inter-statement indentation - i.e. I didn't change the alignment of key-value pairs, which gofmt will do. that would require a bit more effort to rectify if not automated, but let me know if interested

Type of change

Docs bug fix

  • 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 and took screenshots as per above

  • 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 code block formatting and indentation consistency in guides for clearer presentation.
    • Adjusted surrounding blank lines and spacing to enhance readability without changing code behavior.
    • Updated the changelog to record these formatting fixes under Unreleased.

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

- 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

Copy link
Copy Markdown
Contributor

Walkthrough

This PR makes formatting-only edits to documentation: normalizes indentation and blank lines in code blocks within the Application Development guide, and adds a changelog "Fixed" entry. No semantic changes, public API, or code logic were modified.

Changes

Cohort / File(s) Summary
Documentation formatting
website/docs/guides/application-development.mdx
Normalized indentation and spacing inside code blocks (Bind/Greet/EnumBind examples) and adjusted surrounding blank lines; no semantic or control-flow changes.
Changelog update
website/src/pages/changelog.mdx
Added an "Unreleased" → "Fixed" entry noting the indentation fix in the Application Development guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Verify only whitespace/formatting edits exist in website/docs/guides/application-development.mdx.
  • Confirm changelog addition in website/src/pages/changelog.mdx is accurate and contains no unintended edits.

Suggested labels: Documentation

🐇 I hopped through lines to make them neat and trim,
Tabs and spaces dancing, each edge now prim,
A tiny patch, a gentle tune,
The guide now hums beneath the moon,
Happy hops for tidy vim!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing inconsistent indentation in the application development documentation.
Description check ✅ Passed The description follows the template structure with all major sections completed, including a clear explanation of the issue, type of change checkbox, testing details, and mostly completed checklist.
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 66adbf2 and f5cbdd4.

📒 Files selected for processing (2)
  • website/docs/guides/application-development.mdx (5 hunks)
  • website/src/pages/changelog.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • website/docs/guides/application-development.mdx
  • website/src/pages/changelog.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Run Go Tests (ubuntu-22.04, 1.23)
  • GitHub Check: Run Go Tests (ubuntu-24.04, 1.23)
  • GitHub Check: Run Go Tests (windows-latest, 1.23)
  • GitHub Check: semgrep-cloud-platform/scan

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

Copy link
Copy Markdown

@leaanthony leaanthony merged commit e37a7b9 into wailsapp:master Nov 30, 2025
12 of 14 checks passed
@agilgur5 agilgur5 deleted the fix-v2-app-dev-indentation branch November 30, 2025 18:41
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.

2 participants