Skip to content

docs: add USAGE.md — complete user guide with scenarios and troubleshooting#14

Merged
sagar-grv merged 1 commit into
mainfrom
fix/usage-docs
May 25, 2026
Merged

docs: add USAGE.md — complete user guide with scenarios and troubleshooting#14
sagar-grv merged 1 commit into
mainfrom
fix/usage-docs

Conversation

@sagar-grv
Copy link
Copy Markdown
Owner

User documentation — USAGE.md

Adds a comprehensive 558-line user guide covering every scenario, all generated files, deep-dive troubleshooting, and FAQ.

Sections

  1. Quick Start — 3 steps with real terminal output
  2. Scenario: New / empty project
  3. Scenario: Existing Node.js app
  4. Scenario: App with deploy URL (health.yml explained)
  5. Scenario: Monorepo
  6. Scenario: GitLab CI
  7. Scenario: Bitbucket Pipelines
  8. What each generated file does (all 8 files explained)
  9. Commands reference table
  10. Troubleshooting — 13 items (Node version, npx cache, permissions, Windows PATH, proxy, monorepo detection, CodeQL, and more)
  11. FAQ — 7 questions

README.md change

Added one line after Quick Start linking to USAGE.md.

@sagar-grv sagar-grv merged commit 851e52f into main May 25, 2026
3 checks passed
@sagar-grv sagar-grv deleted the fix/usage-docs branch May 25, 2026 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants