diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 302e80599a..7d8d489968 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -73,5 +73,5 @@ knowledge_base: filePatterns: - "cpp/REVIEW_GUIDELINES.md" - "python/REVIEW_GUIDELINES.md" - - "docs/source/contributing.md" - - "docs/source/developer_guide.md" + - "CONTRIBUTING.md" + - "fern/pages/developer_guide.md" diff --git a/fern/pages/contributing.md b/CONTRIBUTING.md old mode 100755 new mode 100644 similarity index 93% rename from fern/pages/contributing.md rename to CONTRIBUTING.md index 7b3bd81fe3..cd33c5120c --- a/fern/pages/contributing.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ into three categories: ## Code contributions -Performance-critical changes require [proper benchmarks](cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. +Performance-critical changes require [proper benchmarks](fern/pages/cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. ### Your first issue diff --git a/README.md b/README.md index ccfa62a838..64f147138a 100755 --- a/README.md +++ b/README.md @@ -206,7 +206,7 @@ For more code examples of the Rust APIs, including a drop-in project templates, ## Contributing -If you are interested in contributing to the cuVS library, 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 principles. +If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](CONTRIBUTING.md). Refer to the [Developer Guide](fern/pages/developer_guide.md) for details on the developer guidelines, workflows, and principles. ## References diff --git a/fern/docs.yml b/fern/docs.yml index 810bd8f1eb..602ac2fa43 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -220,7 +220,7 @@ navigation: - page: "Link-time Optimization" path: "./pages/jit_lto_guide.md" - page: "Contributing" - path: "./pages/contributing.md" + path: "../CONTRIBUTING.md" - section: "API Reference" contents: - section: "C API Documentation" diff --git a/fern/pages/developer_guide.md b/fern/pages/developer_guide.md index 58c287b6ce..18a25d2666 100644 --- a/fern/pages/developer_guide.md +++ b/fern/pages/developer_guide.md @@ -23,4 +23,4 @@ Use these pages when contributing to cuVS or working on integrations that need t ## Contributing -- [Contributing](contributing.md): learn how to set up a development environment, submit changes, and work with the project. +- [Contributing](/developer-guide/contributing): learn how to set up a development environment, submit changes, and work with the project.