Skip to content

fix: add missing heading anchors for doom-lint#177

Merged
luohua13 merged 1 commit intorelease-2.1from
hotfix-2.1/lint-error
Apr 2, 2026
Merged

fix: add missing heading anchors for doom-lint#177
luohua13 merged 1 commit intorelease-2.1from
hotfix-2.1/lint-error

Conversation

@luohua13
Copy link
Copy Markdown
Contributor

@luohua13 luohua13 commented Apr 2, 2026

Summary

  • Add explicit custom IDs (\{#id}) to headings that are referenced by anchor links
  • Fix 10 doom-lint:no-unmatched-anchor errors across 7 documentation files
  • In MDX files, braces are escaped as \{#id} to avoid JSX expression parsing

Changes

File Heading Anchor ID
docs/en/dify/install.mdx Storage (S3 and PVC) storage-s3-and-pvc
docs/en/installation/ai-cluster.mdx Downloading downloading
docs/en/installation/ai-cluster.mdx Uploading uploading
docs/en/installation/ai-cluster.mdx Enabling Knative Functionality enabling-knative-functionality
docs/en/label_studio/install.mdx 4.1 Disable User Registration 41-disable-user-registration
docs/en/llama_stack/quickstart.mdx How to prepare Python 3.12 in Notebook how-to-prepare-python-312-in-notebook
docs/en/model_inference/inference_service/functions/inference_service.mdx Create inference service create-inference-service
docs/en/model_inference/model_management/functions/model_repository.mdx Create Model and Upload Model Files create-model-repository
docs/en/trustyai/ai-guardrails.mdx Ports and roles ports-and-roles

Test plan

  • Run doom lint - 0 errors, 0 warnings

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added comprehensive guides for Kubeflow (Notebooks, Pipelines, TensorBoards, Model Registry)
    • Added TrustyAI documentation (installation, LM evaluation, AI guardrails)
    • Added LLM Compressor documentation and getting-started examples
    • Added KServe model storage and KEDA autoscaling guides
    • Updated product naming across documentation for consistency
    • Enhanced workbench image configuration guidance
  • Chores

    • Updated dependencies and package manager versions
    • Added Docker image synchronization script
    • Updated build pipeline configurations
    • Added example Jupyter notebooks for model compression workflows

Add explicit custom IDs to headings referenced by anchor links to fix
doom-lint:no-unmatched-anchor errors. In MDX files, braces must be
escaped as \{#id} to avoid JSX expression parsing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Caution

Review failed

Failed to post review comments

Walkthrough

This PR adds comprehensive documentation for new platform features including Kubeflow integration, LLM Compressor toolkit, and TrustyAI components. It also updates existing installation guides, adds KEDA autoscaling and ModelCar support documentation, introduces supporting artifacts (Jupyter notebooks and Docker sync script), and updates configuration files and release notes to reflect version 2.1.0.

Changes

Cohort / File(s) Summary
Spell Check & Git Configuration
.cspell/compound.txt, .gitignore
Added ipynb to spell-check allowlist and .claude directory/CLAUDE.md file to gitignore patterns.
CI/CD Pipeline Configuration
.tekton/doc-build.yaml, .tekton/doc-pr-build.yaml
Increased workspace PVC storage from 1Gi to 5Gi and removed tag-based branch filter from doc-build CEL expression.
Documentation Navigation & Weights
docs/en/apis/index.mdx, docs/en/glossary.mdx, docs/en/llama_stack/index.mdx
Updated weight values for documentation page ordering and renamed Llama Stack to "Alauda Build of Llama Stack".
Kubeflow Integration
docs/en/kubeflow/index.mdx, docs/en/kubeflow/intro.mdx, docs/en/kubeflow/how_to/notebooks.mdx, docs/en/kubeflow/how_to/pipelines.mdx, docs/en/kubeflow/how_to/model-registry.mdx, docs/en/kubeflow/how_to/tensorboards.mdx, docs/en/kubeflow/how_to/volumes-kserve.mdx
Added complete Kubeflow documentation suite including introduction, how-to guides for notebooks, pipelines, model registry, TensorBoards, and volume management with KServe.
LLM Compressor Documentation
docs/en/llm-compressor/index.mdx, docs/en/llm-compressor/intro.mdx, docs/en/llm-compressor/how_to/index.mdx, docs/en/llm-compressor/how_to/compressor_by_workbench.mdx
Added LLM Compressor documentation including introduction, how-to guides for compression workflows via Workbench, and overview page.
TrustyAI Documentation
docs/en/trustyai/index.mdx, docs/en/trustyai/intro.mdx, docs/en/trustyai/install.mdx, docs/en/trustyai/lm-eval.mdx, docs/en/trustyai/ai-guardrails.mdx
Added complete TrustyAI documentation including installation, introduction, LM-Eval job configuration, and AI Guardrails deployment and usage.
Installation Guides
docs/en/installation/ai-cluster.mdx, docs/en/installation/ai-generative.mdx, docs/en/installation/kubeflow.mdx
Restructured Knative enablement sections with migration guidance, renamed "Alauda AI Generative" to "Alauda Build of KServe", and migrated Kubeflow Model Registry from Helm chart to Operator-based deployment.
Model Inference & KServe
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx, docs/en/model_inference/inference_service/how_to/keda_autoscaling.mdx, docs/en/model_inference/inference_service/how_to/using_modelcar.mdx, docs/en/model_inference/model_management/functions/model_storage.mdx
Added MODEL_PATH fallback logic, KEDA-based autoscaling guide, ModelCar/OCI container support guide, and comprehensive model storage options documentation (S3, PVC, OCI).
Workbench Documentation
docs/en/workbench/how_to/create_workbench.mdx, docs/en/workbench/how_to/fine_tunning_using_notebooks.mdx
Updated workbench images to odh-workbench-...-ubi9 variants, added Docker image synchronization script documentation, and included kubectl installation note.
Documentation Structure & Metadata
docs/en/dify/install.mdx, docs/en/label_studio/install.mdx, docs/en/model_inference/inference_service/functions/inference_service.mdx, docs/en/model_inference/model_management/functions/model_repository.mdx, docs/en/llama_stack/quickstart.mdx
Added explicit MDX heading anchors for improved internal linking and documentation navigation.
Architecture & Release Notes
docs/en/overview/architecture.mdx, docs/en/overview/release_notes.mdx
Updated architecture component names to reflect branding changes (KServe, vLLM, llm-d), bumped release version from 2.0.0 to 2.1.0, and updated feature list to include ModelCar, LLM Compressor, KEDA autoscaling, TrustyAI components, and evaluation harness.
Public Resources
docs/public/calibration-compressor.ipynb, docs/public/data-free-compressor.ipynb, docs/public/sync-from-dockerhub.sh
Added Jupyter notebooks for LLM Compressor calibration and data-free quantization workflows, and added Bash script for syncing Docker Hub images to private registries.
Build & Package Configuration
package.json, doom.config.yml, tsconfig.json
Bumped @alauda/doom to ^1.21.0, updated Yarn to 4.12.0, added export and prepare scripts, updated release notes query templates to target AI-v2.1.0, and reformatted tsconfig.json.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • add trustyai docs #139: Both PRs add and modify the same TrustyAI documentation files (docs/en/trustyai/*), including index, install, intro, lm-eval, and ai-guardrails pages.
  • split plugin Alauda Build of Kserve #162: Both PRs modify docs/en/installation/ai-cluster.mdx with overlapping changes to Knative/KServe installation and migration guidance.
  • Update for model registry operator #125: Both PRs modify docs/en/installation/kubeflow.mdx to replace the Kubeflow Model Registry Helm chart with the Operator-based installation approach.

Suggested reviewers

  • typhoonzero
  • zhaomingkun1030
  • sinbadonline

Poem

🐰 Documentation sprouts in every direction,

New features bundled with perfect selection!

Kubeflow, TrustyAI, compression so bright,

ModelCars soaring to new heights,

Hop through the guides—knowledge ignites! 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding missing heading anchors to fix linting errors.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hotfix-2.1/lint-error

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Ruff (0.15.7)
docs/public/calibration-compressor.ipynb

Unexpected end of JSON input

docs/public/data-free-compressor.ipynb

Unexpected end of JSON input


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@luohua13 luohua13 changed the base branch from master to release-2.1 April 2, 2026 09:27
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 05f4bfc
Status: ✅  Deploy successful!
Preview URL: https://46ef254f.alauda-ai.pages.dev
Branch Preview URL: https://hotfix-2-1-lint-error.alauda-ai.pages.dev

View logs

@luohua13 luohua13 merged commit 0bb31ff into release-2.1 Apr 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant