Skip to content

Update documentation paths for PhoenixAI #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanRoscigno wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update documentation paths for PhoenixAI #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc48b3c
Update documentation paths for PhoenixAI
DanRoscigno Jul 22, 2026
8f74e91
Also update the docstring usage example (celerdata-docs -> phoenixai-…
DanRoscigno Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ python3 drift_audit.py --component be --repo . --changed-since origin/main
# Split-repo: code from StarRocks, docs from another repo (e.g. commercial docs)
python3 drift_audit.py --component fe \
--code-file /path/to/starrocks/fe/.../Config.java \
--docs-dir /path/to/celerdata-docs/.../FE_parameters
--docs-dir /path/to/phoenixai-docs/.../FE_parameters
```

`--format` is `text` (default), `json`, or `markdown`. Exit code is non-zero when
Expand Down Expand Up @@ -73,7 +73,7 @@ to the job's Step Summary.
## Consumers

- **StarRocks/starrocks** — see note below.
- **CelerData commercial docs** (`celerdata-cloud-docs`, `phoenixdata-docs`, …) —
- **PhoenixAI commercial docs** (`phoenixdata-docs`, …) —
run against the StarRocks codebase (which they build on) with their own
`--docs-dir`.

Expand Down
2 changes: 1 addition & 1 deletion drift_audit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
# Audit code from GitHub against docs in another repo (e.g. commercial docs):
python3 drift_audit.py --component fe \\
--code-file /path/to/Config.java \\
--docs-dir /path/to/celerdata-docs/en/.../FE_parameters
--docs-dir /path/to/phoenixai-docs/en/.../FE_parameters

# In CI, restrict findings to params touched by this PR:
python3 drift_audit.py --component be --repo . --changed-since origin/main
Expand Down
Loading