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

API Documentation needs explanations #158

Open
domoritz opened this issue Jan 31, 2024 · 5 comments
Open

API Documentation needs explanations #158

domoritz opened this issue Jan 31, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@domoritz
Copy link
Contributor

The API docs at https://docs.socketify.dev/api.html don't describe the parameters or what the methods do.

@cirospaciari
Copy link
Owner

Yeah and we need a better site too, this is too little information.
We should be able to search for something and get the API with description and at least one use case of example.

@cirospaciari cirospaciari added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Feb 1, 2024
@megaterium
Copy link

If it help, I've created a GPT with the documentation. Might be useful here.

#162 (comment)

@greg-martinez44
Copy link

I can help with docs if this is still available.

@avylera
Copy link

avylera commented Feb 15, 2024

Hello, I loved to be assigned to this task!

@cirospaciari
Copy link
Owner

cirospaciari commented Feb 15, 2024

Everyone can help :D just open a PR and I will take a look to merge it

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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants