codex-rs Bazel docs contain stale file references

Open Beginner friendly
#25,536 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust

Research direction

Start with codex-rs/docs/bazel.md and compare its relative references with the repository-root MODULE.bazel and defs.bzl files. Update the stale paths and MODULE.bzl filename reference, then verify that every referenced file exists at the documented location.

Written by the indexing model from the issue text.

Description

CLI documentation
What happened?

codex-rs/docs/bazel.md contains stale or incorrect Bazel file references:

  • It says ../MODULE.bazel defines Bazel dependencies and Rust toolchains, but from codex-rs/docs/ the repo-root file is ../../MODULE.bazel.
  • It says ../defs.bzl provides codex_rust_crate, but from codex-rs/docs/ that file is ../../defs.bzl.
  • It refers to ../MODULE.bzl for crate.annotation, but there does not appear to be a MODULE.bzl file in the repo; the relevant file is MODULE.bazel.
Expected behavior

The Bazel docs should use valid relative paths from codex-rs/docs/bazel.md and refer to the actual Bazel module file name.

Additional context

I searched open issues and PRs for terms including codex-rs/docs/bazel.md, MODULE.bazel, MODULE.bzl, and defs.bzl, and did not find an existing open item that appears to cover these stale file references.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.