Already on OSS? Start with the comparison guide, then use the upgrade guide if you - need Pro. + need Pro. No token is required for non-production evaluation.
@@ -444,6 +444,11 @@ function UpgradeSection() {OSS to Pro
Once the comparison says Pro is worth it, follow the upgrade guide and add the Pro - package. + package. The friendly license model keeps non-production evaluation token-free.
Open the upgrade guide+ Development, test, CI/CD, and staging can run without a token. Production deployments + require a paid license. +
+ + Pro pricing and sign up + +Pro extends React on Rails for teams that need higher SSR throughput, RSC-oriented - rendering features, and guided production support. You can evaluate Pro without a - license. + rendering features, and guided production support. The friendly license model lets + you evaluate Pro without a token before you need a production license.
+Friendly evaluation policy
-You can try React on Rails Pro without a license while evaluating.
+Friendly license model
++ Try Pro freely in development, test, CI/CD, and staging. If no license is + configured, Pro keeps running in unlicensed mode and logs license status instead of + blocking your app. +
++ Production deployments require a paid license. Visit{' '} + Pro pricing and sign up for current + options. +
If your organization is budget-constrained, email{' '} justin@shakacode.com. We can grant free licenses in qualifying cases.
-- The goal is to make the upgrade path clear and low-friction, not to force a second - docs silo. -
Need pricing, implementation guidance, or a free-license discussion? Visit{' '} + Pro pricing and sign up or{' '} the Pro docs landing page.
diff --git a/scripts/audit-docs.mjs b/scripts/audit-docs.mjs index 4aecc1a..edddb4b 100644 --- a/scripts/audit-docs.mjs +++ b/scripts/audit-docs.mjs @@ -169,9 +169,6 @@ function findSuspiciousLinks(lineInfo) { if (target.includes("www.shakacode.com/react-on-rails-pro/docs/")) { issues.push(`Legacy Pro docs domain link (${target}).`); } - if (target.includes("pro.reactonrails.com")) { - issues.push(`Dead pro subdomain link (${target}).`); - } } return [...new Set(issues)]; diff --git a/scripts/prepare-docs.mjs b/scripts/prepare-docs.mjs index 2e5bd8e..9411639 100644 --- a/scripts/prepare-docs.mjs +++ b/scripts/prepare-docs.mjs @@ -269,6 +269,10 @@ async function archiveLegacyDocs(docsRoot) { return true; } +export function fixProNodeRendererMdx(content) { + return content.replace("Direct render: <50ms", "Direct render: <50ms"); +} + async function fixKnownDocsIssues(docsRoot) { await rewriteDocsByPattern(docsRoot, [ { @@ -358,6 +362,8 @@ async function fixKnownDocsIssues(docsRoot) { content.replace("using React 18's `renderToPipeableStream`", "using React 19's `renderToPipeableStream`") ); + await rewriteDoc(docsRoot, "pro/node-renderer.md", fixProNodeRendererMdx); + await rewriteDoc(docsRoot, "api-reference/view-helpers-api.md", (content) => content.replace("using React 18+ streaming", "using React 19+ streaming") ); @@ -394,14 +400,10 @@ async function fixKnownDocsIssues(docsRoot) { pattern: /https:\/\/www\.shakacode\.com\/react-on-rails-pro\/docs\//g, replacement: "https://reactonrails.com/docs/pro/" }, - { - pattern: /https:\/\/pro\.reactonrails\.com\/?/g, - replacement: "https://reactonrails.com/docs/pro/" - } ]); } -async function rewriteProLinks(proDocsRoot) { +export async function rewriteProLinks(proDocsRoot) { if (!(await exists(proDocsRoot))) { return; } @@ -414,15 +416,14 @@ async function rewriteProLinks(proDocsRoot) { const updated = original .replace(/((?:\.\.\/)+)oss\//g, "$1") .replace(/https:\/\/www\.shakacode\.com\/react-on-rails\/docs\//g, "https://reactonrails.com/docs/") - .replace(/https:\/\/www\.shakacode\.com\/react-on-rails-pro\/docs\//g, "https://reactonrails.com/docs/pro/") - .replace(/https:\/\/pro\.reactonrails\.com\/?/g, "https://reactonrails.com/docs/pro/"); + .replace(/https:\/\/www\.shakacode\.com\/react-on-rails-pro\/docs\//g, "https://reactonrails.com/docs/pro/"); if (updated !== original) { await fs.writeFile(absoluteFile, updated, "utf8"); } }); } -async function rewriteFlattenedOssLinks(docsRoot) { +export async function rewriteFlattenedOssLinks(docsRoot) { await walkFiles(docsRoot, async (absoluteFile, relativeFile) => { if (!relativeFile.endsWith(".md") && !relativeFile.endsWith(".mdx")) { return; @@ -436,15 +437,14 @@ async function rewriteFlattenedOssLinks(docsRoot) { .replace(/\.\.\/\.\.\/images\//g, "../images/") .replace(/\.\.\/\.\.\/\.\.\/assets\//g, "../../assets/") .replace(/https:\/\/www\.shakacode\.com\/react-on-rails\/docs\//g, "https://reactonrails.com/docs/") - .replace(/https:\/\/www\.shakacode\.com\/react-on-rails-pro\/docs\//g, "https://reactonrails.com/docs/pro/") - .replace(/https:\/\/pro\.reactonrails\.com\/?/g, "https://reactonrails.com/docs/pro/"); + .replace(/https:\/\/www\.shakacode\.com\/react-on-rails-pro\/docs\//g, "https://reactonrails.com/docs/pro/"); if (updated !== original) { await fs.writeFile(absoluteFile, updated, "utf8"); } }); } -async function injectProFriendlyNotice(docsRoot) { +export async function injectProFriendlyNotice(docsRoot) { const proIntroPath = path.join(docsRoot, "pro", "react-on-rails-pro.md"); if (!(await exists(proIntroPath))) { return; @@ -464,8 +464,8 @@ async function injectProFriendlyNotice(docsRoot) { } } - if (!updated.includes("Friendly evaluation policy")) { - const notice = `> **Friendly evaluation policy**\n> You can evaluate React on Rails Pro without a license.\n> If your organization is budget-constrained, email [justin@shakacode.com](mailto:justin@shakacode.com). We can provide free licenses in qualifying cases.\n\n`; + if (!/Friendly license model/i.test(updated)) { + const notice = `> **Friendly license model**\n> Try React on Rails Pro freely in development, test, CI/CD, and staging. No token is required to evaluate. If no license is configured, Pro keeps running in unlicensed mode and logs license status instead of blocking your app. Production deployments require a paid license; see [Pro pricing and sign up](https://pro.reactonrails.com/).\n\n`; updated = updated.replace(/^# React on Rails Pro\s*\n+/m, `# React on Rails Pro\n\n${notice}`); } @@ -652,14 +652,20 @@ async function normalizeCodeFences(docsRoot) { } } -function docsHomeMarkdown(sourceMarkdown, { hasArchive }) { +export function docsHomeMarkdown(sourceMarkdown, { hasArchive }) { const archiveBlock = hasArchive ? "- [Historical Reference](./archive/README.md)\n" : ""; + const friendlyLicenseSection = `## Friendly License Model + +- Try React on Rails Pro freely in development, test, CI/CD, and staging. No token is required to evaluate. +- Production deployments require a paid license. See [Pro pricing and sign up](https://pro.reactonrails.com/) for current options. If your organization is budget-constrained, [contact us](mailto:justin@shakacode.com) about free or low-cost licenses. +`; const updated = sourceMarkdown .trim() .replaceAll("(./oss/", "(./") .replace("](https://reactonrails.com/examples)", "](/examples)") .replace(/\n- \[Documentation website\]\(https:\/\/reactonrails\.com\/docs\/\)\s*/g, "\n") + .replace(/## Friendly evaluation policy\n\n[\s\S]*?(?=\n## )/, `${friendlyLicenseSection}\n`) .replace("## Need more help?\n\n", `## Need more help?\n\n${archiveBlock}`); return `---\ncustom_edit_url: null\n---\n\n${updated}\n`; @@ -778,7 +784,9 @@ async function main() { await prepareDocusaurus(); } -main().catch((error) => { - console.error(error); - process.exitCode = 1; -}); +if (process.argv[1] && path.resolve(process.argv[1]) === __filename) { + main().catch((error) => { + console.error(error); + process.exitCode = 1; + }); +} diff --git a/scripts/prepare-docs.test.mjs b/scripts/prepare-docs.test.mjs new file mode 100644 index 0000000..9ecd957 --- /dev/null +++ b/scripts/prepare-docs.test.mjs @@ -0,0 +1,96 @@ +import assert from "node:assert/strict"; +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import test from "node:test"; + +import { + docsHomeMarkdown, + fixProNodeRendererMdx, + injectProFriendlyNotice, + rewriteFlattenedOssLinks, + rewriteProLinks, +} from "./prepare-docs.mjs"; + +async function withTempDir(callback) { + const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "prepare-docs-test-")); + try { + return await callback(tmpDir); + } finally { + await fs.rm(tmpDir, { recursive: true, force: true }); + } +} + +test("prepare docs keeps external Pro pricing links", async () => { + await withTempDir(async (docsRoot) => { + const ossDocPath = path.join(docsRoot, "getting-started", "oss-vs-pro.md"); + const proDocPath = path.join(docsRoot, "pro", "installation.md"); + await fs.mkdir(path.dirname(ossDocPath), { recursive: true }); + await fs.mkdir(path.dirname(proDocPath), { recursive: true }); + await fs.writeFile( + ossDocPath, + "[Pro pricing and sign up](https://pro.reactonrails.com/)\n", + "utf8" + ); + await fs.writeFile( + proDocPath, + "[Pro pricing and sign up](https://pro.reactonrails.com/)\n", + "utf8" + ); + + await rewriteFlattenedOssLinks(docsRoot); + await rewriteProLinks(path.join(docsRoot, "pro")); + + assert.match(await fs.readFile(ossDocPath, "utf8"), /https:\/\/pro\.reactonrails\.com\//); + assert.match(await fs.readFile(proDocPath, "utf8"), /https:\/\/pro\.reactonrails\.com\//); + }); +}); + +test("prepare docs injects current friendly license model notice", async () => { + await withTempDir(async (docsRoot) => { + const proIntroPath = path.join(docsRoot, "pro", "react-on-rails-pro.md"); + await fs.mkdir(path.dirname(proIntroPath), { recursive: true }); + await fs.writeFile( + proIntroPath, + "# React on Rails Pro\n\nExisting Pro overview.\n", + "utf8" + ); + + await injectProFriendlyNotice(docsRoot); + + const updated = await fs.readFile(proIntroPath, "utf8"); + assert.match(updated, /slug: \/pro/); + assert.match(updated, /Friendly license model/); + assert.match(updated, /development, test, CI\/CD, and staging/); + assert.match(updated, /https:\/\/pro\.reactonrails\.com\//); + assert.doesNotMatch(updated, /Friendly evaluation policy/); + }); +}); + +test("docs homepage uses current friendly license model copy", () => { + const sourceMarkdown = `# React on Rails + +## Friendly evaluation policy + +- You can try React on Rails Pro without a license while evaluating. +- If your organization is budget-constrained, [contact us](mailto:justin@shakacode.com) about free licenses. + +## Need more help? +`; + + const updated = docsHomeMarkdown(sourceMarkdown, { hasArchive: false }); + + assert.match(updated, /## Friendly License Model/); + assert.match(updated, /development, test, CI\/CD, and staging/); + assert.match(updated, /https:\/\/pro\.reactonrails\.com\//); + assert.doesNotMatch(updated, /Friendly evaluation policy/); +}); + +test("Pro node renderer table comparisons are escaped for MDX", () => { + const sourceMarkdown = "| First request on fresh deploy | 410->retry | Direct render: <50ms |\n"; + + assert.equal( + fixProNodeRendererMdx(sourceMarkdown), + "| First request on fresh deploy | 410->retry | Direct render: <50ms |\n" + ); +});