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

Update Documentation #55

Open
vishalverma9572 opened this issue Oct 3, 2024 · 6 comments
Open

Update Documentation #55

vishalverma9572 opened this issue Oct 3, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed

Comments

@vishalverma9572
Copy link
Owner

as new PR has been merged so we need to update Documentation
1.Update Feature Descriptions: Add information about the newly merged features, explaining their functionality and usage. Ensure that all the new updates are covered clearly for users and developers.

2.Modify API Documentation: If the new PR involved backend changes or new routes, ensure those API endpoints are documented with details like request methods, parameters, and responses.

3.Update Setup Instructions: If the new changes affect installation, setup, or configuration processes, modify the documentation to reflect the new steps or requirements.

4.Add Screenshots or Examples: If the PR involves UI changes, include updated screenshots or usage examples to provide a visual guide for users.

@kenudeh
Copy link

kenudeh commented Oct 12, 2024

I'll take this up, if it's still open.

@kenudeh
Copy link

kenudeh commented Oct 12, 2024

Also just looked at the existing documentation. It can and should be better than what is currently obtainable. I'd even suggest moving the entire docs to a proper static site generator, like Mintlify.

@vishalverma9572
Copy link
Owner Author

@kenudeh, assigned! You can work on this....

@kenudeh
Copy link

kenudeh commented Oct 12, 2024

That's great! I'll review the new PR you referenced to get an idea of everything.

@danieltayal07
Copy link

is this done or is this available ?
if it is available i would like to contribute

@kenudeh
Copy link

kenudeh commented Oct 18, 2024

Working on it already @danieltayal07

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 hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants