Skip to content

Conversation

@amrit110
Copy link
Member

@amrit110 amrit110 commented Nov 3, 2025

This pull request adds a comprehensive command-line interface (CLI) reference for the aieng-platform-onboard tool, making it easier for users to understand installation, usage, options, onboarding steps, environment variables, and troubleshooting. The documentation is now included in the site navigation for improved discoverability.

Documentation improvements:

  • Added a detailed cli.md file covering installation, CLI commands, onboarding workflow, options, environment variables, exit codes, examples, generated files, troubleshooting, and support information.

Site navigation:

  • Updated mkdocs.yml to include the new CLI documentation in the navigation menu, making it accessible from the main docs site.

@amrit110 amrit110 self-assigned this Nov 3, 2025
@amrit110 amrit110 added the documentation Improvements or additions to documentation label Nov 3, 2025
@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.88%. Comparing base (08c0cbd) to head (ed80690).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #26   +/-   ##
=======================================
  Coverage   82.88%   82.88%           
=======================================
  Files           3        3           
  Lines         409      409           
=======================================
  Hits          339      339           
  Misses         70       70           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amrit110 amrit110 merged commit 6351f1f into main Nov 3, 2025
5 checks passed
@amrit110 amrit110 deleted the add_cli_docs branch November 3, 2025 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants