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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #43

Open
jgardona opened this issue Nov 4, 2023 · 1 comment
Open

Improve documentation #43

jgardona opened this issue Nov 4, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@jgardona
Copy link

jgardona commented Nov 4, 2023

Description

Docs is very poor, and what I understood about the cli is it only works with sql. Looked polars sql documentation but there are few contents also. Cant know what is the commands I can use while working with dataset, than I think some examples are necessary.
@jgardona jgardona added the enhancement New feature or request label Nov 4, 2023
@stinodego stinodego changed the title Needs more documentation Improve documentation Jan 4, 2024
@stinodego
Copy link
Contributor

It would be nice if we could set up a simple MkDocs and publish it with GitHub pages, similar to how it's done in the main repo.

We could include some more usage examples / installation instructions and include a full overview of supported functionality.

This is currently not a priority for me. If someone wants to pick this up, I would be happy to review a contribution.

@Azizadx Azizadx mentioned this issue Jun 2, 2024
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stinodego @jgardona