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

Better documentation needed #50

Open
5 of 6 tasks
Ukendio opened this issue Jun 8, 2024 · 1 comment
Open
5 of 6 tasks

Better documentation needed #50

Ukendio opened this issue Jun 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@Ukendio
Copy link
Owner

Ukendio commented Jun 8, 2024

We need to add comprehensive documentation to our GitHub repository to help new contributors understand the project, its structure, and how to contribute. Proper documentation will also assist users in understanding how to use the project effectively.

Documentation should include:

  1. Overview

    • Brief description of the project.
    • Key features and functionalities.
  2. Installation

    • Prerequisites.
    • Step-by-step installation guide.
    • Configuration instructions.
  3. Usage

    • How to run the project.
    • Basic usage examples.
    • Explanation of main components.
  4. Contributing

    • Contribution guidelines.
    • How to report issues.
    • How to submit pull requests.
    • Code of conduct.
  5. FAQs

    • Common issues and troubleshooting.
    • Frequently asked questions.
  6. License

    • Licensing information.

Additional Notes:

  • Use Markdown for documentation.
  • Include images/screenshots where applicable.
  • Ensure the documentation is easy to navigate and well-organized.

Tasks:

  • Create an overview section.
  • Write installation instructions.
  • Provide usage examples.
  • Draft contributing guidelines.
  • Compile FAQs.
  • Add license information.
@Ukendio Ukendio added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 8, 2024
@Ukendio Ukendio added this to the 0.2.0 milestone Jun 8, 2024
@Ukendio Ukendio modified the milestones: 0.2.0, 0.3.0 Jul 6, 2024
@EncodedVenom EncodedVenom pinned this issue Aug 19, 2024
@EncodedVenom EncodedVenom added the documentation Improvements or additions to documentation label Aug 19, 2024
@sasial-dev
Copy link

It should also include a "Migrating from matter page" to highlight the differences between it and matter.

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants