Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Add feature documentation #125

Open
4 of 11 tasks
stijnmoreels opened this issue Feb 8, 2022 · 1 comment
Open
4 of 11 tasks

Add feature documentation #125

stijnmoreels opened this issue Feb 8, 2022 · 1 comment
Assignees
@stijnmoreels
Labels
documentation All issues related to documentation enhancement New feature or request
Milestone
v1.1

Comments

@stijnmoreels
Copy link
Member

stijnmoreels commented Feb 8, 2022 •
edited
Loading

Is your feature request related to a problem? Please describe.
Currently, we have a generated list of the current API available in the library, but we don't have any kind of user guide or feature documentation.

Describe the solution you'd like
Add an user documentation for:

The documentation should guide users in:

  • What is the purpose/added-value of this?
    • Why should I use it?
    • Advandates.
  • How can I use it? Remarks on the input (dataframes or arrays)? Examples! (can be Jupyter, but that is still in analysis if we can use that in the Docusaurus page)
    • Thorough explanation of the available parameter.
@stijnmoreels stijnmoreels added documentation All issues related to documentation enhancement New feature or request labels Feb 8, 2022
@stijnmoreels stijnmoreels added this to the v1.1 milestone Feb 8, 2022
@stijnmoreels
Copy link
Member Author

I can give a start on this, @ALaks96 , but will probably need some help as I will most definitely describe things wrongly.

@stijnmoreels stijnmoreels self-assigned this May 5, 2022
@stijnmoreels stijnmoreels mentioned this issue May 6, 2022
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@stijnmoreels stijnmoreels

Labels
documentation All issues related to documentation enhancement New feature or request
Projects
None yet
Milestone
v1.1
Development

No branches or pull requests
1 participant
@stijnmoreels