update doc and test cases #83
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request focuses on improving documentation clarity and updating test coverage for the network configuration generator tool. The main README has been streamlined to simplify the quick start process, and a new summary of test cases has been added. Additionally, new expected output files have been introduced for Cisco NX-OS "switched" scenarios and Dell OS10 BMC switch convertor tests.
Documentation improvements:
README.mdquick start section has been simplified by removing redundant subsections and now directs users to a consolidateddocs/QUICK_START.mdguide. The "Choose Your Path", "Basic Usage", and "Quick Examples" sections were removed in favor of a single link to the new quick start guide, and all references todocs/EXECUTABLE_USAGE.mdhave been updated todocs/QUICK_START.md. [1] [2] [3] [4]docs/QUICK_START.md(renamed fromdocs/EXECUTABLE_USAGE.md) now provides a concise overview of command-line usage, available options, and examples, including a demo GIF. Redundant or overly detailed sections have been removed or condensed. [1] [2]Test coverage and expected outputs:
tests/TEST_CASES_SUMMARY.md, which provides a clear summary of test coverage, pass/fail/skip status, and a breakdown of test scenarios for both the configuration generator and lab input convertor.tests/test_cases/convert_lab_switch_input_json_dell_os10/expected_outputs/s46-r06-3248bmc-6-1.json.