Rename the Running Locally sidebar entry to Contributor Setup - #1310
Open
RichardBray wants to merge 1 commit into
Open
Rename the Running Locally sidebar entry to Contributor Setup#1310RichardBray wants to merge 1 commit into
RichardBray wants to merge 1 commit into
Conversation
"Running Locally" and "Self-hosting" both describe running Firecrawl locally, so the sidebar gave readers no way to tell them apart. Someone who wants to run Firecrawl on their own box reasonably clicks "Running Locally" and lands in the contributor toolchain (Node, pnpm, Redis, Go, Rust) when the Docker Compose path on the self-hosting page was what they wanted. "Contributor Setup" names the audience instead of the mechanism, which is the actual difference between the two pages. Self-hosting keeps its title: it matches SELF_HOST.md and it is the term people search for. Page title, description, and URL are unchanged. Localized files are left to the translation pipeline per CLAUDE.md.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Why
Running LocallyandSelf-hostingboth describe running Firecrawl locally, so the sidebar gives readers no way to tell them apart. Someone who wants to run Firecrawl on their own box reasonably clicks Running Locally and lands in the contributor toolchain (Node 22, pnpm 11.4.0, hand-installed Redis, Go 1.23, Rust) when the Docker Compose path on the self-hosting page was what they wanted.The real difference between the two pages is the audience, not the mechanism: one is for changing Firecrawl code, the other for running a pinned release.
Contributor Setupsays that in two words, which is about all a sidebar scan affords.What changed
contributing/guide.mdx:sidebarTitleis nowContributor Setup.contributing/open-source-or-cloud.mdxandcontributing/self-host.mdxupdated to match, dropping a now-redundant "contributor" in the surrounding sentence.Self-hostingkeeps its title: it matchesSELF_HOST.mdand it is the term people search for.Scope
Page
title,description,og:*, and the URL are all unchanged, so no SEO or link impact. Localized copies underes/,fr/,ja/,pt-BR/, andzh/are untouched perCLAUDE.md; the translation pipeline owns them.