Skip to content

Conversation

@prameshsharma25
Copy link
Collaborator

Background

  • This project uses MkDocs to generate documentation. To make the documentation more robust and easier to maintain, we are integrating automatic generation of CLI help output.

Why

  • Provide easier access to rich, always up-to-date documentation for all SSDraw command-line arguments.
  • The documentation for CLI flags (ssdraw single, ssdraw multi) will now be dynamically generated directly from the Python argparse definition, ensuring consistency and preventing documentation drift.

What Was Changed

  • Added docs folder with new docs style imported form mkdocs
  • Added scripts for cli command generation
  • Updated Makefile to address future builds

Validation

  • Ran make serve-docs, which successfully executed the Python script to update the Markdown files and started the MkDocs server.
  • Content Verification: Navigated to both the single and multi pages and verified that the fully-formatted CLI help output is displayed in a code block.
  • Deployment Check: Verified that the static files were built and deployed correctly to the GitHub Pages URL.

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