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

Write documentation #28

Open
anandology opened this issue Sep 17, 2021 · 3 comments
Open

Write documentation #28

anandology opened this issue Sep 17, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@anandology
Copy link
Contributor

We need good documentation for joy. Probably hosted as a separate website. May be https://fossunited.github.io/joy.

What all we need:

  • one page reference of joy
  • different patterns of using joy
  • how to install joy
  • how to use joy in jupyter
  • how to use joy in vscode
  • gallery, linking to sketches on mon.school
@anandology anandology added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 17, 2021
@ravish0007
Copy link

Hello @anandology,

I would like to help.

@anandology
Copy link
Contributor Author

Hey @ravish0007, thanks for taking this up.

Here the rough idea.

  1. setup docs using mkdocs (you can see https://github.org/fossunited/coursectl as an example)
  2. setup github ci to push the docs to github pages to make it live at https://fossunited.github.io/joy
  3. Have the following pages in the docs:
    1. Introduction
    2. Reference
    3. Gallery

The docs should have link to the github repo and the joy of programming course.

Do you have any more suggestions to make it better?

I can quickly setup skeleton for 1 and 2. Can you focus on the 3.

@ravish0007
Copy link

Yes, I'll focus on the 3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants