wangzhigang1999 opened a new pull request, #89: URL: https://github.com/apache/paimon-vector-index/pull/89
## What does this pull request change? This PR adds a Docusaurus documentation site that follows the main Apache Paimon documentation stack and visual baseline. It: - migrates the 11 existing documentation pages to maintainable Markdown sources under `docs-src/`; - adds the Docusaurus project under `docs-site/`, including navigation, local search, dark mode, and edit links; - generates compatibility redirects for the existing `*.html` public URLs; - builds the site and validates generated links and anchors in the existing CI check job; - updates the README with the published documentation and local preview commands. The old committed `docs/` output remains in place. The current `paimon-website` workflow can continue publishing it until a follow-up website PR switches that workflow to `docs-site/build/`. ## Why is this needed? The repository currently maintains complete HTML pages and its own page layout by hand. Navigation, metadata, and styling become harder to keep consistent as the documentation grows. Markdown plus Docusaurus keeps the content reviewable and uses the same documentation tooling as Apache Paimon. Closes #88. ## Rollout This is the first of two repository changes: 1. Merge the documentation source and build in `paimon-vector-index` while retaining `docs/`. 2. Update `paimon-website` to build this site and copy the generated static files into `docs/vector-index`. After the published canonical and legacy URLs have been verified, the old committed HTML can be removed in a separate cleanup. ## Verification - `yarn --cwd docs-site install --frozen-lockfile` - `yarn --cwd docs-site build` - `python3 tools/check_docs.py docs-site/build` checks 24 generated HTML pages - `python3 tools/check_license_headers.py` - `python3 -m unittest discover -s tools/tests -p 'test_*.py'` - `git diff --check` The Markdown migration also includes the documentation changes from #85, which landed while this work was in progress. -- 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]
