docs: add supported-remotes.md — clarify remote compatibility for OSS users#1317
docs: add supported-remotes.md — clarify remote compatibility for OSS users#1317AkshatRaj00 wants to merge 1 commit into
Conversation
|
Hi @AkshatRaj00! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Summary
This PR adds a new documentation page
website/docs/introduction/supported-remotes.mdthat clearly explains which remote repositories are supported by Sapling for open-source users.This directly addresses the documentation gap described in issue #1287.
Problem
New Sapling users — especially those coming from Git — are frequently confused about the remote support story. The current docs don't have a dedicated page that answers: "Can I use Sapling with GitLab? With a self-hosted Gitea? What happened to Mercurial support?"
This confusion is a real adoption barrier. Users spend time experimenting or asking on issues (e.g., #1287, #1186) to find out what should be a one-minute read in the docs.
What This PR Adds
supported-remotes.mdin the Introduction section of the docs.gitmode vs nativeslmode with copy-paste examplessl pr, ISL, andsl ghstackWhy This Matters
This page makes that statement explicit and complete, so potential adopters immediately understand the supported workflow and don't have to piece it together from scattered issues and installation notes.
Checklist
introduction/sectionCloses #1287