Skip to content

[BUG] Documentation: 5 Environment Variables Missing from README #35

@EnthusiasticTech

Description

@EnthusiasticTech

Project

vgrep

Description

Several environment variables are implemented in the code but not documented in the README, making it difficult for users to configure the application via environment variables.

Error Message

Debug Logs

Environment variables IN THE README:
VGREP_CONTENT
VGREP_HOST
VGREP_MAX_RESULTS
VGREP_PORT

Environment variables ACTUALLY in the code:
VGREP_CHUNK_OVERLAP
VGREP_CHUNK_SIZE
VGREP_CONTENT
VGREP_HOST
VGREP_MAX_FILE_SIZE
VGREP_MAX_RESULTS
VGREP_PORT
VGREP_SKILL
VGREP_WATCH_DEBOUNCE

System Information

Bounty Version: 0.1.0
OS: Ubuntu 24.04 LTS
CPU: AMD EPYC-Genoa Processor (8 cores)
RAM: 15 GB

Screenshots

No response

Steps to Reproduce

  • Compare documented env vars with actual code:
    # In README:grep -o 'VGREP_[A-Z_]*' README.md | sort -u# In code:grep -oh 'VGREP_[A-Z_]*' src/*.rs src/**/*.rs | sort -u

Expected Behavior

All environment variables should be documented in the README under the "Environment Variables" section.

Actual Behavior

5 environment variables are undocumented:
MISSING from documentation:

  • VGREP_CHUNK_OVERLAP
  • VGREP_CHUNK_SIZE
  • VGREP_MAX_FILE_SIZE
  • VGREP_SKILL
  • VGREP_WATCH_DEBOUNCE

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingvalidValid issuevgrep

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions