Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Polish v1 & v2 documentation #172

Open
4 tasks
andir opened this issue Dec 2, 2022 · 1 comment
Open
4 tasks

Polish v1 & v2 documentation #172

andir opened this issue Dec 2, 2022 · 1 comment

Comments

@andir
Copy link
Collaborator

andir commented Dec 2, 2022

With the merge of #166 we are in a bit of a weird situation with the documentation.

The documentation was updated for the changed API that was developed as part of support the version 2 of the NPM lock files. Somewhere along the path it was decided that these new changes should be exposed as a dedicated attribute. This will keep the old (called v1) code alive and we can introduce the new features as v2.

  • Proof read the API.md
  • Split v1 documentation into API-v1.md
  • Move the v2 documentation into API-v2.md
  • Make the API.md describe that we expose two versions of the api and link to those
@zmrocze
Copy link

zmrocze commented May 9, 2023

im polish so this is very anticipated, would make it way easier to understand. Keep up the good work!

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

No branches or pull requests

2 participants