FelixYBW opened a new pull request, #13372:
URL: https://github.com/apache/gluten/pull/13372
## What changes are proposed in this pull request?
Velox, Bolt and ClickHouse documents are currently mixed with common docs in
`docs/`, `docs/get-started/` and `docs/developers/`. This PR moves
backend-specific docs into per-backend directories:
```
docs/
├── index.md, Configuration.md # common
├── get-started/ # common: getting-started,
build-guide, GlutenUI
├── developers/ # common developer docs
└── backends/
├── velox/
│ ├── get-started/ Velox.md, VeloxS3.md, VeloxIceberg.md, ...
│ ├── developers/ VeloxUDF.md, velox-function-development-guide.md,
...
│ └── *.md configuration, function support, limitations,
troubleshooting
├── bolt/
│ ├── get-started/ Bolt.md, BoltFileSystem.md, ...
│ ├── developers/ bolt-function-development-guide.md
│ └── *.md configuration, function support, quick start,
migration guide
└── clickhouse/
├── get-started/ ClickHouse.md
└── developers/ clickhouse-backend-debug.md,
UsingJemallocWithCH.md, ...
```
- Files are moved with `git mv` (content unchanged except relative links);
file names are kept.
- All relative links in Markdown are rewritten; a link checker reports no
new broken links.
- `mkdocs.yml` nav is regrouped into a section per backend (Bolt docs are
added to the nav).
- `README.md`, `AGENTS.md`, `CONTRIBUTING.md` links updated.
- Doc generators updated to write to the new paths: `AllVeloxConfiguration`,
`AllBoltConfiguration`, `tools/scripts/gen-function-support-docs.py`,
`tools/scripts/diff-function-support-docs.py`.
## How was this patch tested?
- Script-based check that every relative link in tracked Markdown resolves
(same result before/after).
- Verified every file under `docs/` is referenced in the mkdocs nav and
every nav entry exists.
- `spotless:check` on `backends-velox` and `backends-bolt`.
## Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude claude-opus-5-5
🤖 Generated with [Claude Code](https://claude.com/claude-code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
