search

0xOpenBytes / Picture

🚧 Under Construction 🚧
https://0xopenbytes.github.io/Picture/
MIT License
3 stars 2 forks source link

Add Public Documentation #7

Open 0xLeif opened 1 year ago

0xLeif commented 1 year ago

We need to add comprehensive documentation for all public APIs throughout the project. This documentation should include clear and detailed explanations of the APIs, their input parameters, expected output, and any additional information that would assist developers in utilizing the APIs effectively.

bellatrick commented 9 months ago

Hi. @0xLeif I would like to work on this issue. Please let me know if this task is still open and if yes, could you please point me to how to get started. Thanks!

0xLeif commented 9 months ago

Hey @bellatrick! Thank you for your interest in this project! For the documentation, we really only need to document anything that is public. There is a folder under source called public that should contain all of the objects that need documentation.

I think it would be best to start with one file and get a Pull Request up for that. Then you could do multiple files next or still do them one by one.

Let me know if you have any questions!

bellatrick commented 9 months ago

Hey @bellatrick! Thank you for your interest in this project! For the documentation, we really only need to document anything that is public. There is a folder under source called public that should contain all of the objects that need documentation.

I think it would be best to start with one file and get a Pull Request up for that. Then you could do multiple files next or still do them one by one.

Let me know if you have any questions!

Sounds good. Do you want the documentation to be written in the form of inline comments in the code, or should a separate markdown file be created for each file?

0xLeif commented 9 months ago

@bellatrick preferably it would be best to have inline documentation at the minimum as it will use DocC to compile and upload the documentation to GitHub pages. After we have inline code documentation we could make separate files or a wiki for more information or documentation. Examples are welcome too for the inline documentation or readme.

bellatrick commented 9 months ago

@bellatrick preferably it would be best to have inline documentation at the minimum as it will use DocC to compile and upload the documentation to GitHub pages. After we have inline code documentation we could make separate files or a wiki for more information or documentation. Examples are welcome too for the inline documentation or readme.

Alright got it. Will get started with the inline documentation. I'll let you know if I have questions