Create a Wiki or an External Web Site that Provides Detailed Tool Use Documentation

AstuteSource / chasten

:dizzy: Chasten Uses XML and XPATH to Check a Python Program's AST for Specified Patterns!

https://pypi.org/project/chasten/

GNU General Public License v2.0

7 stars 8 forks source link

Create a Wiki or an External Web Site that Provides Detailed Tool Use Documentation #21

Closed gkapfham closed 1 year ago

gkapfham commented 1 year ago

While the current README.md file for chasten provides a basic overview of the commands and how they work, it does not include a significant number of examples. This means that it is important to create either a wiki inside of this repository or an external web site, ideally using Material for Mkdocs or Quarto, that will provide additional documentation for the tool!

AlishChhetri commented 1 year ago

I would like to tackle this task, but I currently do not have permission to assign myself to the issue.

gkapfham commented 1 year ago

Hello @AlishChhetri, you are assigned to this issue. Can you please give us a status update?

AlishChhetri commented 1 year ago

I created the external site and will continue to maintain and add content to it throughout the semester.

Link: https://chastendocs.netlify.app/