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

[doc test] test all the docs in kusionstack.io thoroughly, keep docs up to date #160

Closed
amyXia1994 opened this issue Oct 14, 2022 · 0 comments
Assignees
Labels
ci documentation Improvements or additions to documentation

Comments

@amyXia1994
Copy link
Contributor

amyXia1994 commented Oct 14, 2022

docs need to be tested

  • [the most important] step by step tutorials must be fluent, without any blocking error, and can be reproduced precisely as documented
  • links within the website must be valid
  • command line usage doc must be consistent with the actual output
  • the terminologies and statements of the same concept must be consistent throughout the website

ways to accomplish the goal

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants