Skip to content

Commit 277102c

Browse files
committed
Refactor troubleshooting and usage documentation for clarity and organization
- Simplified the structure of TROUBLESHOOTING.md, consolidating sections and improving readability. - Updated usage examples in USAGE.md to reflect direct invocation and integration patterns. - Enhanced clarity on environment variables and their effects. - Improved instructions for running Python scripts, using pip, and managing virtual environments. - Added common patterns and troubleshooting tips for better user guidance.
1 parent a6bbe38 commit 277102c

9 files changed

Lines changed: 1090 additions & 4223 deletions

File tree

docs/ARCHITECTURE.md

Lines changed: 130 additions & 486 deletions
Large diffs are not rendered by default.

docs/BUILD.md

Lines changed: 100 additions & 505 deletions
Large diffs are not rendered by default.

docs/CI_CD.md

Lines changed: 109 additions & 589 deletions
Large diffs are not rendered by default.

docs/CONTRIBUTING.md

Lines changed: 131 additions & 468 deletions
Large diffs are not rendered by default.

docs/FAQ.md

Lines changed: 101 additions & 371 deletions
Large diffs are not rendered by default.

docs/INSTALLATION.md

Lines changed: 91 additions & 305 deletions
Large diffs are not rendered by default.

docs/TECHNICAL.md

Lines changed: 183 additions & 450 deletions
Large diffs are not rendered by default.

docs/TROUBLESHOOTING.md

Lines changed: 139 additions & 532 deletions
Large diffs are not rendered by default.

docs/USAGE.md

Lines changed: 106 additions & 517 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)