Skip to content

Stop describing Spacefast with the word hosting - #125

Open
batuhan wants to merge 1 commit into
mainfrom
no-hosting-copy
Open

batuhan wants to merge 1 commit into
mainfrom
no-hosting-copy

Conversation

@batuhan

@batuhan batuhan commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

What changed

Spacefast is never described with the word "hosting" (rule from batuhan, Nov 11 2026).

  • content/api/errors.mdx: provider_job_failed and provider_job_timeout rows say "provider job".
  • content/(serve)/domains.mdx: "hosting check" is now "serving check".
  • content/platforms/partner-api/configuration.mdx: example presentation name "Example Hosting" is now "Example Cloud".
  • Vale: new styles/Spacefast/Hosting.yml makes whole-word "hosting" an error. It replaces HostingProvider.yml, which only banned "the hosting provider". STYLE_GUIDE.md and AGENTS.md describe the new rule.
  • verify:prose passes locally with Vale 3.17.1 (990 pages, 2872 OpenAPI prose fields).

Kept for now (exempt from the rule)

  • generated/ is a verified snapshot synced from spacefast/monorepo, so it is not hand-edited. Its error pages, OpenAPI descriptions and shipped changelog still contain "hosting". .vale.ini exempts content/(reference)/errors/** and the OpenAPI prose extraction, and the existing changelog carve-out also skips the rule, so CI stays green.

Follow-ups

  • Merge the parallel monorepo PR (error docs, OpenAPI descriptions, CLI --hosting-kind), refresh generated/, then delete the two exemptions in .vale.ini marked for removal. Changelog history stays exempt.
  • node --test scripts/*.test.mjs has 13 failures with and without this change (they need a built site); CI runs them after the build.

View in Indent View in Slack
Tag @indent to continue the conversation here.


Show it working
Open in [code]smith · Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Updated domain-validation guidance to describe the check as a “serving” check.
    • Clarified provider job error descriptions and changed the partner API example name to “Example Cloud.”
    • Updated product terminology guidance to prefer alternatives such as “publish,” “serve,” “infrastructure,” or “runtime” when describing Spacefast.
  • Style
    • Added a writing rule against using “hosting” to describe Spacefast; generated content and the changelog remain exempt.

@indent

indent Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Issues

No issues found.

CI Checks

All required CI checks passed on c3bcc50.

Review agents

Select any unchecked box below to run or rerun that agent.

Passed (1)
  • Indent Review Agent · No issues found; Vale prose check passes.
Full results

Indent Review Agent

  • Summary: No issues found; Vale prose check passes.
  • Last ran on commit: c3bcc502
  • Latest result
    {
      "summary": "No issues found; Vale prose check passes.",
      "findings": []
    }

@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Vale rule now flags “hosting” in Spacefast prose and lists alternatives. Vale configuration exempts specified generated content. Guidance and selected documentation use revised wording, including “serving” for the domain preflight check.

Changes: Hosting terminology

Layer / File(s) Summary
Terminology guidance and enforcement
AGENTS.md, STYLE_GUIDE.md, styles/Spacefast/Hosting.yml, styles/Spacefast/HostingProvider.yml, .vale.ini
Guidance and Vale rules prohibit “hosting” in Spacefast prose and list alternatives. The Vale configuration exempts the shipped changelog, generated error pages, and OpenAPI prose.
Documentation wording
content/(serve)/domains.mdx, content/api/errors.mdx, content/platforms/partner-api/configuration.mdx
The domain preflight description changes “hosting” to “serving.” Error descriptions refer to provider jobs, and the example name changes to “Example Cloud.”

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

  • spacefast/docs#124: Updates product copy to avoid “hosting,” aligning with the terminology rule added here.

Suggested reviewers: alexanderaidun-a8c

Merge Risk: Minimal · up to c3bcc

This updates documentation wording and prose lint rules to avoid the word "hosting". It has no runtime impact and no actionable merge risk remains.

Architecture risk: Low · up to c3bcc

The change affects 4 systems.

Changed systems: content, styles, AGENTS.md, STYLE_GUIDE.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — content (service) was modified; 3 changed files map to changed impact.
  • observed — styles (service) was modified; 2 changed files map to changed impact.
  • observed — AGENTS.md (service) was modified; 1 changed file maps to changed impact.
  • observed — STYLE_GUIDE.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in AGENTS.md: The Vale rules replace the specific prohibition on “the hosting provider” with a ban on “hosting” in prose, list replacement terms, and exempt generated error pages, OpenAPI prose, and the shipped changelog until the generated snapshot is refreshed.
  • observed — Modified behavior in STYLE_GUIDE.md: The guidance replaces the ban on calling Spacefast’s infrastructure “the hosting provider” with a ban on using “hosting” for Spacefast or its features, and lists preferred alternatives.
  • observed — Modified behavior in content/(serve)/domains.mdx: The preflight description changes the check compared with adding a domain from “hosting” to “serving”; its validation, advisory verdict, and stated outcomes are unchanged.
  • observed — Modified behavior in content/api/errors.mdx: The provider_job_failed and provider_job_timeout descriptions change from “hosting-provider job” to “provider job.”
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Stop describing Spacefast with the word hosting" states the main change: the PR bans the word "hosting" when describing Spacefast. The changeset matches this. It adds the Vale rule styles/S…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Stop describing Spacefast with the word hosting" states the main change: the PR bans the word "hosting" when describing Spacefast. The changeset matches this. It adds the Vale rule styles/Spacefast/Hosting.yml, removes HostingProvider.yml, updates STYLE_GUIDE.md and AGENTS.md, and rewords domains.mdx, errors.mdx, and configuration.mdx to drop "hosting" in favor of "serving", "provider job", and "Example Cloud". The title is short, specific, and free of file lists or vague terms.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: cef2a391-0e59-4ae8-b43d-8e481a4a220b
Commits

Reviewing files that changed from the base of the PR and between e84d3ee and c3bcc50.

Files selected for processing: 8

  • .vale.ini
  • AGENTS.md
  • STYLE_GUIDE.md
  • content/(serve)/domains.mdx
  • content/api/errors.mdx
  • content/platforms/partner-api/configuration.mdx
  • styles/Spacefast/Hosting.yml
  • styles/Spacefast/HostingProvider.yml
Files with no reviewable changes: 1

  • styles/Spacefast/HostingProvider.yml

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

This branch was successfully deployed

1 active deployment
preview/no-hosting-copy — c3bcc502 Deployed Nov 11, 2026 by spacefast[bot]
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.

1 participant