Skip to content

docs(community): use absolute link to CoC instead of relative#4732

Merged
leaanthony merged 4 commits into
wailsapp:masterfrom
agilgur5:fix-coc-absolute-link
Nov 30, 2025
Merged

docs(community): use absolute link to CoC instead of relative#4732
leaanthony merged 4 commits into
wailsapp:masterfrom
agilgur5:fix-coc-absolute-link

Conversation

@agilgur5

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

Copy link
Copy Markdown
Contributor

Description

Fixes #NA

Just stumbled upon this while reading through the Contributing Guide.

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

  • 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

  • Bug Fixes
    • Fixed an issue with the Community Guide Code of Conduct link that occurred when accessing it with a trailing slash.

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

@agilgur5
docs(community): use absolute link to CoC instead of relative
7d6f680 
- the relative link made it so that if you happen to land on https://wails.io/community-guide/ (with a trailing slash), it would take you to https://wails.io/community-guide/coc, which 404s
  - if you were at https://wails.io/community-guide (no trailing slash), it was fine.
  - use an absolute link so that it works the same regardless of the trailing slash or not
@coderabbitai

coderabbitai Bot commented Nov 23, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Updates the Community Guide's Code of Conduct link from relative to absolute path ("/coc"), and documents this fix in the changelog. The change improves link routing consistency when trailing slashes are present.

Changes

Cohort / File(s) Change Summary
Community Guide Fix
website/src/pages/community-guide.mdx		 Updated Code of Conduct link from relative path "./coc" to absolute path "/coc"
Changelog Entry
website/src/pages/changelog.mdx		 Added new Fixed entry under Unreleased documenting the Community Guide CoC link fix for trailing slash handling

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

  • Verify the absolute path /coc correctly resolves to the Code of Conduct resource
  • Confirm the changelog entry accurately describes the fix

Poem

A hop and a skip through the docs we go,
The CoC link now has the perfect flow,
From relative paths to absolute grace,
No trailing slash shall find misplaced,
The changelog sings of problems now blessed! 🐰✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: replacing a relative CoC link with an absolute one.
Description check ✅ Passed The PR description comprehensively covers the issue (trailing slash causing 404), motivation, testing, and properly completed the template 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 9578b62 and 1d8d1ae.

📒 Files selected for processing (2)
  • website/src/pages/changelog.mdx (1 hunks)
  • website/src/pages/community-guide.mdx (1 hunks)
⏰ 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). (2)
  • GitHub Check: Run Go Tests (macos-latest, 1.23)
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
website/src/pages/community-guide.mdx (1)

9-9: Link routing fix looks good.

Changing the CoC link from relative ./coc to absolute /coc correctly resolves the trailing-slash routing inconsistency. This ensures users land on the correct page regardless of URL format.

website/src/pages/changelog.mdx (1)

19-19: Changelog entry is accurate and well-formatted.

The entry correctly documents the fix with proper attribution, PR reference, and description. Placement in the "Fixed" section under "Unreleased" is appropriate.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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.

@leaanthony leaanthony enabled auto-merge (squash) November 25, 2025 10:16
@leaanthony

leaanthony commented Nov 25, 2025

Copy link
Copy Markdown
Member

Thanks!

@agilgur5

agilgur5 commented Nov 29, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@leaanthony the CI seems to have stalled here for some reason ("Run Go Tests" has been pending indefinitely) and seems to need manual intervention.

Also would you be able to review my other small docs PRs?

@leaanthony

leaanthony commented Nov 29, 2025

Copy link
Copy Markdown
Member

Ah man. Sorry about that. Will have a look tomorrow 👍👍

@leaanthony leaanthony self-requested a review November 30, 2025 06:19
@leaanthony leaanthony disabled auto-merge November 30, 2025 06:19
@leaanthony leaanthony merged commit d16fd50 into wailsapp:master Nov 30, 2025
10 of 12 checks passed
@sonarqubecloud

sonarqubecloud Bot commented Nov 30, 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

@agilgur5 agilgur5 deleted the fix-coc-absolute-link branch November 30, 2025 18:41
@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