Skip to content
This repository was archived by the owner on Jul 23, 2024. It is now read-only.

feat: Create user documentation #699

Closed
1 task done
tfuxu opened this issue Jan 10, 2023 · 10 comments
Closed
1 task done

feat: Create user documentation #699

tfuxu opened this issue Jan 10, 2023 · 10 comments
Labels
area/documentation Improvements or additions to documentation feature-request
Milestone
0.8.0

Comments

@tfuxu
Copy link
Member

tfuxu commented Jan 10, 2023

Feature description

Not much to say here, we just need to create a user documentation to unclutter our repository README, and to give users more info on some features.

Additional Context

No response

Did you read the Code of Conduct?
@tfuxu tfuxu added enhancement New feature or request feature-request labels Jan 10, 2023
@daudix
Copy link
Member

daudix commented Jan 10, 2023

We can do this by using GitHub wiki feature, so no need in separate website

@tfuxu
Copy link
Member Author

tfuxu commented Jan 10, 2023

GitHub wiki is quite limiting as it doesn't have many basic features most documentation software offers. I think it would be better to make docs on Read the Docs (basically Sphinx free hosting) or Gitbook.

@tfuxu tfuxu added this to the 0.8.0 milestone Jan 11, 2023
@tfuxu tfuxu added area/documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 11, 2023
@tfuxu tfuxu mentioned this issue Jan 11, 2023
Closed
1 task
@0xMRTT
Copy link
Member

0xMRTT commented Jan 11, 2023 •
edited
Loading

I think that Sphinx is the best because that will allow us to document the code so i'm for the read the docs solution

PS: i'm finally back, so i can work on that !

@0xMRTT
Copy link
Member

0xMRTT commented Jan 13, 2023

image

Let's go !!!

@daudix
Copy link
Member

daudix commented Jan 13, 2023

Yaaay 🚀🎉

We are now as cool as krita and blender

@0xMRTT
Copy link
Member

0xMRTT commented Jan 13, 2023

image

@0xMRTT
Copy link
Member

0xMRTT commented Jan 13, 2023

I'm creating a pr for that so we can work together

@daudix
Copy link
Member

daudix commented Jan 13, 2023

LFG!

@0xMRTT 0xMRTT mentioned this issue Jan 13, 2023
Closed
5 tasks
@0xMRTT
Copy link
Member

0xMRTT commented Jan 13, 2023

See #701 for progress on this

@tfuxu
Copy link
Member Author

tfuxu commented Feb 25, 2023

Check GradienceTeam/Docs#1 for a updated progress list.

@daudix daudix closed this as completed Apr 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation feature-request
Projects
None yet
Milestone
0.8.0
Development

Successfully merging a pull request may close this issue.

docs: add usage documentation
3 participants
@tfuxu @daudix @0xMRTT