Update CLI/API documentation based upon improvements - Githubissues

mediumroast / mediumroast_js

Mediumroast for GitHub CLI and API/SDK

https://www.mediumroast.io/product.html

Apache License 2.0

1 stars 0 forks source link

Update CLI/API documentation based upon improvements #119

Closed miha42-github closed 1 month ago

miha42-github commented 1 month ago

Introduction

The following documents should be improved based upon this release.

[x] Readme.MD - basic upgrade instructions and pointer to the demo site
[x] Company.md - should include new report command(s)
[x] Interaction.md - should include new report command(s)
[x] cli/Readme.md - include new actions and storage commands
[x] .github/Contributing.md - needs to be revised and linked into the structure of the repository

The following are to be added.

[x] cli/Demo.md - added to show how to interact with the demo site including limitations

Finally, the GitHub Page needs to be rebuilt by running the appropriate NPM command.

[x] Rerun npm docs or whatever the right thing is to generate the documentation for the GitHub page version. Additionally, stare at the configuration file for a minute to see if you can fix the config.

miha42-github commented 1 month ago

Documentation has been updated