Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove redundant installation instructions #1138

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

leseb
Copy link
Contributor

@leseb leseb commented Feb 18, 2025

What does this PR do?

The previous installation instructions were mostly duplicating information already covered in the documentation, either in the “Start a Server” or “Contributing Guide” sections. Removed these redundant details to avoid confusion and streamline the setup process.

Signed-off-by: Sébastien Han [email protected]

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 18, 2025
@ashwinb
Copy link
Contributor

ashwinb commented Feb 20, 2025

Not convinced this should go actually because CONTRIBUTING is for someone to actually make code changes and give back and Start a Server is kind of deep somewhere.

@leseb
Copy link
Contributor Author

leseb commented Feb 20, 2025

Not convinced this should go actually because CONTRIBUTING is for someone to actually make code changes and give back and Start a Server is kind of deep somewhere.

Thanks for the feedback! One of my goals with this PR is to keep the README as a concise entry point to introduce the project. More detailed information, such as installation instructions, belongs in the documentation. A README makes sense as a standalone guide when there’s no separate documentation, but that’s not the case here. I can move these sections to the documentation instead of removing them if you prefer.
What do you think?

The previous installation instructions were mostly duplicating
information already covered in the documentation, either in the “Start a
Server” or “Contributing Guide” sections. Removed these redundant
details to avoid confusion and streamline the setup process.

Signed-off-by: Sébastien Han <[email protected]>
@leseb leseb force-pushed the move-install-to-doc branch from a3ed81f to c8e9b19 Compare February 24, 2025 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants