Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Revamp the docs #729

Open
8 of 9 tasks
reyammer opened this issue Sep 26, 2024 · 0 comments
Open
8 of 9 tasks

Revamp the docs #729

reyammer opened this issue Sep 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@reyammer
Copy link
Collaborator

reyammer commented Sep 26, 2024

  • update main README, for now with a simple callout to the new *-rc python and rust packages
  • update python/README.md with info about the new module (and with a callout about the old docs (pointing to old commits of the repo) and changelog)
  • remove docs/python.md and update all the links to python/README.md
  • update python/CHANGELOG.md
  • add a "Contributing" section in the main README
  • expand the rust's client docs with quick example, help, and a couple of more advanced examples (with json output and input from a url, eg curl https://google.com | magika - -s)
  • Update the citation snippet
  • Consider merging ./docs/magika_output.md into ./python/README.md
  • Consider merging ./docs/command_line.md into ./rust/cli/README.md
@reyammer reyammer added the documentation Improvements or additions to documentation label Sep 26, 2024
@reyammer reyammer added this to the python-0.6.0 milestone Sep 26, 2024
@reyammer reyammer modified the milestones: python-0.6.0, python-0.6.1 Jan 20, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant