docs: sync three pages that drifted from recent commits#205
Open
ahmedhesham6 wants to merge 3 commits into
Open
docs: sync three pages that drifted from recent commits#205ahmedhesham6 wants to merge 3 commits into
ahmedhesham6 wants to merge 3 commits into
Conversation
The Notifications section of the Settings page still listed Email, Webhook, Slack, Discord and In-app. Microsoft Teams shipped as a channel kind in 3fa75f2, which updated docs/api/notifications.mdx but not this page, so a shipped channel went undocumented here. Backed by the code: NotificationsTab.tsx:365 renders an `msteams` option in the add-channel picker, en/settings.json:511 labels it "Microsoft Teams", and notification-workers.ts:359 registers the `msteams` worker. The list now matches the picker's order.
6a11d56 added the Trendshift badge to the root README only. The eight translated READMEs under docs/i18n/ carry the same header blocks — title, tagline, badge row, nav row, language row — so they now differ from the English one. CONTRIBUTING.md:84 states the rule directly: add a badge "to the root README and every localized README". The badge block is copied verbatim from README.md:9-13 and placed in the same slot, between the tagline and the npm/license/website row. It needs no path rewrite because both URLs are absolute, and no translation because the alt text is the product name.
The Domains & SSL troubleshooting page listed three causes for the `"…" is not a valid public hostname.` error: a bare IP, `localhost`, or a single-label name. 71ae8b9 added a fourth by capping each dot-separated label at the 63-octet DNS limit, so a user hitting that case found nothing here explaining it. Traced the message to its source before writing: domain.service.ts:88 throws that exact string, gated on isValidCustomHostname from @repo/core (domain.service.ts:87) — the same function 71ae8b9 changed at packages/core/src/utils.ts:62-64. So the Add domain flow the page documents is the flow the new check runs in.
ahmedhesham6
force-pushed
the
docs/sync-teams-badge-hostname
branch
from
July 24, 2026 13:26
c1265c8 to
d1c4f56
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three docs fixes, each following up a recent commit that changed behaviour without updating the page describing it. Docs only — no source changes.
1. Microsoft Teams missing from the Settings page
3fa75f2addedmsteamsas a notification channel and updateddocs/api/notifications.mdx, butdocs/dashboard/settings.mdxstill listed only Email, Webhook, Slack, Discord and In-app — so a shipped channel went undocumented on the page users read first.Checked against the code rather than the commit message:
NotificationsTab.tsx:365renders themsteamsoption,en/settings.json:511labels it "Microsoft Teams",notification-workers.ts:359registers the worker. The list now matches the picker's order.2. Trendshift badge only on the English README
6a11d56added the badge toREADME.md. The eight translations underdocs/i18n/mirror the English header blocks exactly, so they now differ.CONTRIBUTING.md:84states the rule: add a badge "to the root README and every localized README".The block is copied verbatim from
README.md:9-13into the same slot. No path rewrite (both URLs absolute), no translation (alt text is the product name).3. Hostname rejection reasons now incomplete
71ae8b9capped each dot-separated label at the 63-octet DNS limit, adding a fourth way to trigger"…" is not a valid public hostname.. The troubleshooting page still listed three.Worth noting since that commit only touched
packages/core: I traced the message to confirm the page is in scope.domain.service.ts:88throws that exact string, gated onisValidCustomHostnameat line 87 — the same function changed atpackages/core/src/utils.ts:62-64. The Add domain flow the page documents is the flow the new check runs in.Notes
prettier --write. The committedREADME.mdalready failsprettier --checkbefore these changes, CI doesn't run prettier, and.mdxisn't in theformatglob. Reformatting would bury the change in unrelated churn.