Skip to content

docs: add supported-remotes.md — clarify remote compatibility for OSS users#1317

Open
AkshatRaj00 wants to merge 1 commit into
facebook:mainfrom
AkshatRaj00:docs/add-supported-remotes-guide
Open

docs: add supported-remotes.md — clarify remote compatibility for OSS users#1317
AkshatRaj00 wants to merge 1 commit into
facebook:mainfrom
AkshatRaj00:docs/add-supported-remotes-guide

Conversation

@AkshatRaj00
Copy link
Copy Markdown

Summary

This PR adds a new documentation page website/docs/introduction/supported-remotes.md that 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

  • A new page supported-remotes.md in the Introduction section of the docs
  • A quick-reference table showing support level for: Git remotes, GitHub, GitLab, Bitbucket, Gitea, Mercurial remotes, Mononoke, and a Sapling-native server
  • Clear explanation of .git mode vs native sl mode with copy-paste examples
  • A dedicated GitHub integration section covering sl pr, ISL, and sl ghstack
  • A "Why no Mercurial or Mononoke?" section to preempt FAQ questions
  • A link to issue proposal(pr): use github api directly rather than CLI for github operations #1148 for users interested in contributing non-GitHub review integrations

Why This Matters

"Right now, the practical impression is that Sapling is mainly a better client for Git repositories, but that is not stated as clearly as it probably should be." — #1287

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

  • Docs only — no code changes
  • New file added to existing introduction/ section
  • All remote types covered with accurate support status
  • Links to related issues included
  • Consistent with existing docs tone and Docusaurus markdown format

Closes #1287

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 23, 2026

Hi @AkshatRaj00!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 23, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@meta-cla meta-cla Bot added the CLA Signed label May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation request: supported remotes

1 participant