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

[ENHANCEMENT] - Extensive Documentation #3

Open
yash-srivastava19 opened this issue Jul 12, 2024 · 0 comments
Open

[ENHANCEMENT] - Extensive Documentation #3

yash-srivastava19 opened this issue Jul 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@yash-srivastava19
Copy link
Owner

The docs for the project are available here. I want help in maintaining them, with resources, explanation and examples usage of tools. API reference is generated automatically, so no need to stress on that. The docs should be written in a way that makes Arrakis easier for the use of community. Some points :

  • PRs with simple typos in docs will not be accepted, only PR which add functionality, or enhance Arrakis will be accepted. Read the contributing guidelines for how to contribute to Arrakis.
  • The docs PR should have docs in the branch name. It is much easier that way.
@yash-srivastava19 yash-srivastava19 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jul 12, 2024
@yash-srivastava19 yash-srivastava19 pinned this issue Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant