Skip to content

Updated help link in Network Settings #24597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 4, 2025
Merged

Updated help link in Network Settings #24597

merged 1 commit into from
Aug 4, 2025

Conversation

sagzy
Copy link
Contributor

@sagzy sagzy commented Aug 4, 2025

no issue

  • Social web help docs now have a specific section to explain domain restrictions (custom domain required, subdirectory not supported)

@sagzy
Updated help link in Network Settings
8d13095 
no issue

- Social web help docs now have a specific section to explain domain restrictions (custom domain required, subdirectory not supported)
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 4, 2025 •
edited
Loading

Walkthrough

The change modifies the URL in an informational message within the Network feature toggle component. Specifically, the help link in the displayed message is updated from "https://ghost.org/help/social-web/" to "https://ghost.org/help/social-web/#custom-domain-required". No other aspects of the component, such as logic or error handling, are altered.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 5b8c97d and 8d13095.

📒 Files selected for processing (1)
  • apps/admin-x-settings/src/components/settings/growth/Network.tsx (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings 
Learnt from: sagzy
PR: TryGhost/Ghost#24346
File: apps/admin-x-settings/src/components/settings/growth/Network.tsx:16-16
Timestamp: 2025-07-14T12:20:33.264Z
Learning: In the Network component at apps/admin-x-settings/src/components/settings/growth/Network.tsx, the hardcoded `domainIssue = true` is intentional for static UI implementation, as confirmed by the maintainer sagzy. This is acceptable for early UI development before connecting to actual backend validation.

Learnt from: sagzy
PR: TryGhost/Ghost#24346
File: apps/admin-x-settings/src/components/settings/growth/Network.tsx:8-12
Timestamp: 2025-07-14T12:20:35.268Z
Learning: The Network component toggle in `apps/admin-x-settings/src/components/settings/growth/Network.tsx` is intentionally implemented as static UI with a no-op onChange handler, as part of a UI-first development approach before connecting actual ActivityPub functionality.

Learnt from: kevinansfield
PR: TryGhost/Ghost#23770
File: apps/admin-x-settings/src/components/settings/email/newsletters/NewsletterDetailModalLabs.tsx:435-450
Timestamp: 2025-06-10T11:07:10.800Z
Learning: In Ghost's newsletter customization features, when promoting a feature from alpha to beta status, the feature flag guards are updated to make the feature available under both the `emailCustomization` (beta) and `emailCustomizationAlpha` (alpha) flags. This is done by either removing conditional guards entirely when the component is already behind both flags, or by updating conditionals to check for either flag.

Learnt from: troyciesco
PR: TryGhost/Ghost#24291
File: apps/admin-x-settings/package.json:45-45
Timestamp: 2025-07-09T18:06:09.856Z
Learning: In Ghost admin-x-settings, webhook URL validation uses {require_tld: false} to allow localhost URLs for local integration testing, while social URL validation uses the default {require_tld: true} since social URLs should be public-facing.
📚 Learning: the network component toggle in `apps/admin-x-settings/src/components/settings/growth/network.tsx` i... 
Learnt from: sagzy
PR: TryGhost/Ghost#24346
File: apps/admin-x-settings/src/components/settings/growth/Network.tsx:8-12
Timestamp: 2025-07-14T12:20:35.268Z
Learning: The Network component toggle in `apps/admin-x-settings/src/components/settings/growth/Network.tsx` is intentionally implemented as static UI with a no-op onChange handler, as part of a UI-first development approach before connecting actual ActivityPub functionality.

Applied to files:

  • apps/admin-x-settings/src/components/settings/growth/Network.tsx
📚 Learning: in the network component at apps/admin-x-settings/src/components/settings/growth/network.tsx, the ha... 
Learnt from: sagzy
PR: TryGhost/Ghost#24346
File: apps/admin-x-settings/src/components/settings/growth/Network.tsx:16-16
Timestamp: 2025-07-14T12:20:33.264Z
Learning: In the Network component at apps/admin-x-settings/src/components/settings/growth/Network.tsx, the hardcoded `domainIssue = true` is intentional for static UI implementation, as confirmed by the maintainer sagzy. This is acceptable for early UI development before connecting to actual backend validation.

Applied to files:

  • apps/admin-x-settings/src/components/settings/growth/Network.tsx
📚 Learning: in the ghost admin ui, toggles should not display a checked state when disabled. the design principl... 
Learnt from: sagzy
PR: TryGhost/Ghost#24350
File: apps/admin-x-settings/src/components/settings/growth/Network.tsx:29-33
Timestamp: 2025-07-14T16:46:42.646Z
Learning: In the Ghost Admin UI, toggles should not display a checked state when disabled. The design principle is to either show disabled+unchecked or enabled+toggleable states, never checked+disabled. This applies to components like the Network toggle in apps/admin-x-settings/src/components/settings/growth/Network.tsx.

Applied to files:

  • apps/admin-x-settings/src/components/settings/growth/Network.tsx
📚 Learning: in ghost's newsletter customization features, when promoting a feature from alpha to beta status, th... 
Learnt from: kevinansfield
PR: TryGhost/Ghost#23770
File: apps/admin-x-settings/src/components/settings/email/newsletters/NewsletterDetailModalLabs.tsx:435-450
Timestamp: 2025-06-10T11:07:10.800Z
Learning: In Ghost's newsletter customization features, when promoting a feature from alpha to beta status, the feature flag guards are updated to make the feature available under both the `emailCustomization` (beta) and `emailCustomizationAlpha` (alpha) flags. This is done by either removing conditional guards entirely when the component is already behind both flags, or by updating conditionals to check for either flag.

Applied to files:

  • apps/admin-x-settings/src/components/settings/growth/Network.tsx
📚 Learning: in ghost admin-x-settings, webhook url validation uses {require_tld: false} to allow localhost urls ... 
Learnt from: troyciesco
PR: TryGhost/Ghost#24291
File: apps/admin-x-settings/package.json:45-45
Timestamp: 2025-07-09T18:06:09.856Z
Learning: In Ghost admin-x-settings, webhook URL validation uses {require_tld: false} to allow localhost URLs for local integration testing, while social URL validation uses the default {require_tld: true} since social URLs should be public-facing.

Applied to files:

  • apps/admin-x-settings/src/components/settings/growth/Network.tsx
🔇 Additional comments (1)
apps/admin-x-settings/src/components/settings/growth/Network.tsx (1)

77-78: Link update looks good

The help URL has been updated to the more specific anchor—no issues spotted.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-link-social-web

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sagzy sagzy enabled auto-merge (squash) August 4, 2025 08:46
@sagzy sagzy merged commit 042f4b9 into main Aug 4, 2025
23 checks passed
@sagzy sagzy deleted the update-link-social-web branch August 4, 2025 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peterzimon peterzimon peterzimon 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
@sagzy @peterzimon