Skip to content

docs: build commands omit the required aether working directory #83

Description

@jacktony2001

Problem

The repository layout places the main Rust manifest at aether/Cargo.toml; the repository root does not contain a Cargo.toml. However, the build instructions in README.md, README.fa.md, Docs/DOCS.en.md, and Docs/DOCS.fa.md show cargo build --release without first entering the aether crate.

A reader following the instructions from a fresh repository checkout can therefore run the command from the root and receive Cargo's missing-manifest error. The documented binary path also omits the aether/ prefix when building from the repository root.

Proposed documentation

The root-level instructions should use:

cd aether
cargo build --release

and identify the resulting binary as:

aether/target/release/aether

The same working-directory clarification should be applied to the library build examples in the detailed English and Persian documentation.

Scope

This is a documentation-only issue. It does not request any code or behavior change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions