Skip to content

docs: Add Debug Doc for CLI#58

Merged
Soap-141 merged 1 commit intomainfrom
dev/thla/docs-cli
Feb 20, 2025
Merged

docs: Add Debug Doc for CLI#58
Soap-141 merged 1 commit intomainfrom
dev/thla/docs-cli

Conversation

@Soap-141
Copy link
Copy Markdown
Contributor

@Soap-141 Soap-141 commented Feb 19, 2025

GitHub Issue: #

Proposed Changes

  • Bug fix
  • Feature
  • Code style update (formatting)
  • Refactoring (no functional changes, no api changes)
  • Build or CI related changes
  • Documentation content changes
  • Other, please describe:

Description

Updated documentation on how to debug the CLI.

Impact on version

  • Major
    • The template structure was changed.
  • Minor
    • New functionalities were added.
  • Patch
    • A bug in behavior was fixed.
    • Documentation was changed.

PR Checklist

Always applicable

No matter your changes, these checks always apply.

  • Your conventional commits are aligned with the Impact on version section.
  • Updated CHANGELOG.md.
    • Use the latest Major.Minor.X header if you do a Patch change.
    • Create a new Major.Minor.X header if you do a Minor or Major change.
    • If you create a new header, it aligns with the Impact on version section and matches what is generated in the build pipeline.
  • Documentation files were updated according with the changes.
    • Update README.md and src/cli/CLI.md if you made changes to templating.
    • Update AzurePipelines.md and src/app/README.md if you made changes to pipelines.
    • Update Diagnostics.md if you made changes to diagnostic tools.
    • Update Architecture.md and its diagrams if you made architecture decisions or if you introduced new recipes.
    • ...and so forth: Make sure you update the documentation files associated to the recipes you changed. Review the topics by looking at the content of the doc/ folder.
  • Images about the template are referenced from the wiki and added as images in this git.
  • TODO comments are hints for next steps for users of the template and not planned work.

Contextual

Based on your changes these checks may not apply.

  • Automated tests for the changes have been added/updated.
  • Tested on all relevant platforms

Other information

Internal Issue (If applicable):

@Soap-141 Soap-141 force-pushed the dev/thla/docs-cli branch 2 times, most recently from e515926 to af4ebd6 Compare February 19, 2025 22:33
@Soap-141 Soap-141 marked this pull request as ready for review February 19, 2025 22:33
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
@Soap-141 Soap-141 merged commit e023715 into main Feb 20, 2025
@Soap-141 Soap-141 deleted the dev/thla/docs-cli branch February 20, 2025 17:49
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.

5 participants