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

Maybe a documentation would be enjoyable #1

Open
Wishrito opened this issue Jun 13, 2024 · 4 comments
Open

Maybe a documentation would be enjoyable #1

Wishrito opened this issue Jun 13, 2024 · 4 comments

Comments

@Wishrito
Copy link

I'm new for working with Dolibarr API, well i think a documentation for working with this wrapper would be nice 😊

@JonBendtsen
Copy link
Owner

I'm new for working with Dolibarr API, well i think a documentation for working with this wrapper would be nice 😊

Sounds like a great idea. Can you be a little bit more elaborate as in what the Documentation should contain and which kind of format you think would work well?

@Wishrito
Copy link
Author

😁hmmm i'll do my best to explain what i thinked about, as i'm french

maybe adding some examples for many basic uses, like how to connect to a dolibarr app, how to extract some data from the user database, etc... oh and an idea would be to type the parameters of the API's functions (as much as possible of course), because it would help to understand what type of data we should send when calling the function 👍

@JonBendtsen
Copy link
Owner

😁hmmm i'll do my best to explain what i thinked about, as i'm french

maybe adding some examples for many basic uses, like how to connect to a dolibarr app, how to extract some data from the user database, etc... oh and an idea would be to type the parameters of the API's functions (as much as possible of course), because it would help to understand what type of data we should send when calling the function 👍

okay, so now there is a very very simple example in the usage/ folder

@JonBendtsen
Copy link
Owner

😁hmmm i'll do my best to explain what i thinked about, as i'm french

maybe adding some examples for many basic uses, like how to connect to a dolibarr app, how to extract some data from the user database, etc... oh and an idea would be to type the parameters of the API's functions (as much as possible of course), because it would help to understand what type of data we should send when calling the function 👍

I've added an example which is slightly more complicated, it uses a filter to reduce the data it finds.

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

No branches or pull requests

2 participants