From bf0390728c8d4ab3fe814266cbf05728c6f12aa8 Mon Sep 17 00:00:00 2001 From: "Corey J. Nolet" Date: Thu, 10 Nov 2022 12:49:37 -0500 Subject: [PATCH] Moving contributing and developer guides to main docs --- README.md | 2 +- CONTRIBUTING.md => docs/source/contributing.md | 2 +- DEVELOPER_GUIDE.md => docs/source/developer_guide.md | 0 docs/source/index.rst | 2 ++ 4 files changed, 4 insertions(+), 2 deletions(-) rename CONTRIBUTING.md => docs/source/contributing.md (99%) rename DEVELOPER_GUIDE.md => docs/source/developer_guide.md (100%) diff --git a/README.md b/README.md index ddaf8b3f8d..4115b79f56 100755 --- a/README.md +++ b/README.md @@ -229,7 +229,7 @@ The folder structure mirrors other RAPIDS repos, with the following folders: ## Contributing -If you are interested in contributing to the RAFT project, please read our [Contributing guidelines](CONTRIBUTING.md). Refer to the [Developer Guide](DEVELOPER_GUIDE.md) for details on the developer guidelines, workflows, and principals. +If you are interested in contributing to the RAFT project, please read our [Contributing guidelines](docs/source/contributing.md). Refer to the [Developer Guide](docs/source/developer_guide.md) for details on the developer guidelines, workflows, and principals. ## References diff --git a/CONTRIBUTING.md b/docs/source/contributing.md similarity index 99% rename from CONTRIBUTING.md rename to docs/source/contributing.md index faf777ba42..63ed3f4142 100755 --- a/CONTRIBUTING.md +++ b/docs/source/contributing.md @@ -1,4 +1,4 @@ -# Contributing to RAFT +# Contributing If you are interested in contributing to RAFT, your contributions will fall into three categories: diff --git a/DEVELOPER_GUIDE.md b/docs/source/developer_guide.md similarity index 100% rename from DEVELOPER_GUIDE.md rename to docs/source/developer_guide.md diff --git a/docs/source/index.rst b/docs/source/index.rst index c46f08aac6..e66152b904 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,9 +41,11 @@ While not exhaustive, the following general categories help summarize the accele quick_start.md build.md + developer_guide.md cpp_api.rst pylibraft_api.rst raft_dask_api.rst + contributing.md Indices and tables