diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index f59c7c5391c..1978ba9608e 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -71,6 +71,41 @@ jobs: cat >> docs/src/integrations/.pages << 'EOF' - Ray: ray EOF + - name: Copy contributing docs + run: | + mkdir -p docs/src/community/project-specific/lance + + # Lance project files + cp CONTRIBUTING.md docs/src/community/project-specific/lance/general.md + cp release_process.md docs/src/community/project-specific/lance/release.md + cp rust/CONTRIBUTING.md docs/src/community/project-specific/lance/rust.md + cp python/CONTRIBUTING.md docs/src/community/project-specific/lance/python.md + cp docs/CONTRIBUTING.md docs/src/community/project-specific/lance/docs.md + + # External project files + cp lance-ray/CONTRIBUTING.md docs/src/community/project-specific/ray.md + cp lance-spark/CONTRIBUTING.md docs/src/community/project-specific/spark.md + cp lance-namespace/CONTRIBUTING.md docs/src/community/project-specific/namespace.md + + # Create .pages for project-specific + cat > docs/src/community/project-specific/.pages << 'EOF' + nav: + - index.md + - Lance: lance + - Lance Namespace: namespace.md + - Lance Ray: ray.md + - Lance Spark: spark.md + EOF + + # Create .pages for lance subfolder + cat > docs/src/community/project-specific/lance/.pages << 'EOF' + nav: + - General: general.md + - Release: release.md + - Rust: rust.md + - Python: python.md + - Docs: docs.md + EOF - name: Deploy working-directory: docs run: uv run mkdocs gh-deploy --force diff --git a/docs/src/community/.pages b/docs/src/community/.pages index f576426bb49..e35f62840b4 100644 --- a/docs/src/community/.pages +++ b/docs/src/community/.pages @@ -6,3 +6,4 @@ nav: - Voting: voting.md - Contributing: contributing.md - Release: release.md + - Project Specific Guidelines: project-specific diff --git a/docs/src/community/project-specific/index.md b/docs/src/community/project-specific/index.md new file mode 100644 index 00000000000..acc4750a9d4 --- /dev/null +++ b/docs/src/community/project-specific/index.md @@ -0,0 +1,5 @@ +# Project Specific Guidelines + +This section contains [contributing](../contributing.md) and [release](../release.md) guidelines from different Lance core projects. + +Each project maintains its own detailed guidelines that are automatically pulled from their respective repositories during the documentation build process.