forked from blarApp/blarify
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Summary
Add comprehensive documentation for environment variables used by the VS Code Blarify extension to help users understand configuration options and troubleshooting.
Context
Following the implementation of environment variable-based configuration in PR #55, we should document the environment variables that users might need to know about for advanced configuration and troubleshooting.
Proposed Enhancement
Add a new section to vscode-blarify-visualizer/README.md documenting:
Environment Variables Section
Blarify Configuration Variables:
ROOT_PATH: Workspace path to analyze (set automatically)NEO4J_URI: Neo4j database connection URI (default: bolt://localhost:7957)NEO4J_USER: Neo4j username (default: neo4j)NEO4J_PASSWORD: Neo4j password (managed automatically)ENABLE_LLM_DESCRIPTIONS: Enable AI-powered descriptions (true/false)ENABLE_DOCUMENTATION_NODES: Include documentation nodes (default: true)NAMES_TO_SKIP: Comma-separated list of patterns to excludePYTHONPATH: Python module path (set automatically)
Azure OpenAI Variables (when configured):
AZURE_API_KEY: Azure OpenAI API keyAZURE_ENDPOINT: Azure OpenAI endpoint URLAZURE_DEPLOYMENT: Azure OpenAI deployment name
Troubleshooting Notes:
- These variables are set automatically by the extension
- Manual override possible for advanced users
- Useful for debugging connection issues
Priority
Low - Enhancement for future release
Related
- PR Fix BlarifyIntegration command mismatch - replace 'ingest' with environment variables #55: Fix BlarifyIntegration command mismatch with environment variables
- Code review feedback suggesting documentation improvement
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request