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

Rework the documentation #316

Open
5 of 6 tasks
tristanbes opened this issue Apr 9, 2019 · 0 comments
Open
5 of 6 tasks

Rework the documentation #316

tristanbes opened this issue Apr 9, 2019 · 0 comments
Assignees

Comments

@tristanbes
Copy link

tristanbes commented Apr 9, 2019

  • On documentation index page, in 1/2 sentence, explain what does yProx-cli and what is its difference/advantages compared to other tools.
  • On documentation index page, provide 1 simple example to have a global picture on how easy it is to use it.
  • it minimize -> it minimizes
  • Linting should have its own chapter in the documentation since it's a big "part" in term of features. Explain which tool it's using under the hood.
  • Example -> Examples inside Environment variables and modes
  • Rework this: https://github.com/Yproximite/yProx-cli/blob/master/README.md#L6

Thanks

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