Skip to content

Conversation

0x3639
Copy link
Collaborator

@0x3639 0x3639 commented Jun 22, 2025

Update docs with the help of Claude 4.

@0x3639 0x3639 requested a review from Copilot July 6, 2025 10:18
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR massively expands and restructures the README to provide a comprehensive guide for the Zenon CLI tool, including installation, build instructions, global options, a Table of Contents, detailed command references, best practices, and support information.

  • Added a detailed Table of Contents and reorganized sections for easier navigation.
  • Updated installation and build-from-source instructions with clearer steps and updated repository links.
  • Expanded command summaries, full command reference, tips, error handling, and support sections.
Comments suppressed due to low confidence (2)

README.md:5

  • The Table of Contents currently stops before the 'Tips and Best Practices', 'Error Handling', and 'Support' sections. Please add entries for these sections to the TOC to ensure they are easily discoverable.
## Table of Contents

README.md:31

  • [nitpick] The term 'keyStore' is inconsistently capitalized in other parts of the document. Consider standardizing the casing (e.g., 'keystore') throughout the README for consistency.
**Important:** All required dynamic libraries are included in the `build/` folder. When moving the `znn-cli` binary, ensure you also move the accompanying libraries.

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.

1 participant