Skip to content

chore(docs): remove tracked docs/dist build artifacts#42

Merged
weilaaa merged 1 commit intovolcengine:mainfrom
songyu-bytedance:fix/intelligent-threshold
Dec 16, 2025
Merged

chore(docs): remove tracked docs/dist build artifacts#42
weilaaa merged 1 commit intovolcengine:mainfrom
songyu-bytedance:fix/intelligent-threshold

Conversation

@songyu-bytedance
Copy link
Collaborator

@songyu-bytedance songyu-bytedance commented Dec 16, 2025

Description

  • Remove mistakenly tracked documentation build outputs by deleting docs/dist and ensure future builds are ignored via .gitignore .

  • The branch is rebased on upstream/main to keep history clean and avoid repeated noise from generated artifacts.

  • No functional code changes; this is a repository hygiene cleanup.
    What Changed

  • Deleted tracked docs/dist from version control (commit 8185bc7 ).

  • Rely on existing ignore rule docs/dist/ in .gitignore to prevent future tracking ( /Users/bytedance/Desktop/ve-arch/agent/veaiops/.gitignore:77 ).
    Motivation

  • Build artifacts change frequently and cause:

    • Noisy diffs and merge conflicts that slow reviews.
    • Repository bloat that hurts clone and CI times.
    • Hard-to-diagnose mismatches between local and CI build outputs.
  • Documentation static assets should be produced and published by CI/release pipelines, not stored in the repo.
    Type of Change

  • Documentation/repo hygiene (no functional changes)

  • Bug fix

  • New feature

  • Breaking change

  • Refactoring
    Testing

  • Pre-commit hooks passed ( ruff , bandit , codespell , secret scans, etc.).

  • git status confirms docs/dist is removed and now ignored; rebuilding docs locally does not re-stage the directory.

  • No impact on build or runtime; only tracked artifacts are removed.
    Risk & Impact

  • Low risk: removing generated outputs only, no source or runtime logic changed.

  • If any process relied on docs/dist being in the repo, migrate to CI to build and publish artifacts (static site or artifact registry).
    Rollback Plan

  • If temporary restoration is needed, rebuild docs locally or fetch from the artifact/hosting environment; do not re-commit build outputs to the repo.
    Related

  • Existing ignore rules: docs/_build/ , docs/.output/ , docs/dist/ ( /Users/bytedance/Desktop/ve-arch/agent/veaiops/.gitignore:75–78 ).

  • Branch: songyu-bytedance:fix/intelligent-threshold , rebased onto volcengine:main .
    Checklist

  • Rebased on upstream/main

  • Removed tracked docs/dist

  • Verified .gitignore rules

  • Pre-commit checks passed

  • No functional or API changes

Copy link
Collaborator

@weilaaa weilaaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@weilaaa weilaaa merged commit 97966ba into volcengine:main Dec 16, 2025
2 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.

2 participants