smaranjitghose/girlscript_chennai_website

Documentation of the project

Closed this issue · 13 comments

smaranjitghose commented

Exclusively use Sphinx for this

We want a readthedocs format documentation website for this project. Check out the popular python packages like numpy,pandas,etc

The main page of the documentation should contain the details of the project,aim, and a list of contributors

Then Each section must tell anyone who has even no coding experience, which lines of code to change and where to put the assets to modify the website.

The goal of the project is to make a common template for making it easy for each and every chapter of GirlScript Foundation to setup their website within a few hours. So the documentation should serve the purpose to guide anyone doing this from start to end

You are welcome to contribute if you have the following pre-requisites:

  • Basics of Python
  • Sphinx (Watch Pycon and PyData videos, it's easy to pick up)
  • Markdown, Restructured Text
  • HTML,CSS

Sections :

  • Main page describing the project
  • Detailed Table of Contents
  • Contributors page section
  • Home page section
  • Contact Us page section
  • Team page section
  • Achievements page section
  • Announcements page section
  • Blog page section
  • Dark Mode Switch and Suggestions
  • License and Code of Conduct section
  • Custom theme

Please give all PRs for this to the gh-pages branch

Adyasha8105 commented

Can I?

  • 👍1
shreyakapoor08 commented

@smaranjitghose Can I work on it individually so that the content is aligned throughout? Let me know when to start :)

  • 👍2
smaranjitghose commented

@shreyakapoor08 Definitely you can start working on the documentation whenever you are ready. Since we have to cover all of the pages, it will take quite some time. So please collaborate with @Adyasha8105 on this issue.

  • 👍1
shreyakapoor08 commented

@shreyakapoor08 Definitely you can start off whenever you ready. But, the documentation would take time since we have to cover all of the pages so collaborate with @Adyasha8105 on this please.

Got it 😊
@Adyasha8105 Can we connect over slack?

  • 👍1
smaranjitghose commented

@shreyakapoor08 @Adyasha8105 Please give all PRs for this to the gh-pages branch

  • 👍2
smaranjitghose commented

I guess the majority of home page is completed by now? So I am checking it off

  • 👍1
shreyakapoor08 commented

@smaranjitghose main page describing the project is also done, you can check that also 😊

  • 👍1
CipherGirl commented

Hello mentor and assignees! I and one of my friend @Shadman-Ahmed-Chowdhury were looking for some issues for documentation in GSSoC, unfortunately, we couldn't find much. As this issue is already taken up. Just letting you know if there is some work to split up we'd love to join and work collaboratively!

smaranjitghose commented

@CipherGirl I have assigned both of you the corresponding issue for the GirlScript App project. For this project, once the first phase of the documentation is completed by @shreyakapoor08 and @Adyasha8105 , you are can contribute to enhance it.

shreyakapoor08 commented

@smaranjitghose Announcement section is also complete @Adyasha8105. 😊
You can mark it check ✔️

  • 👍1
saloniankita commented

Can I contribute individually to the Contact Us page section @smaranjitghose ?

smaranjitghose commented

Can I contribute individually to the Contact Us page section @smaranjitghose ?

Pardon me, it was already assigned. Could you work on a custom css for the documenation. @anushbhatia will be able to guide you with this. Moreover, the position of the search bar and stuff needs some improvements, you can fix that too

smaranjitghose commented

@Adyasha8105 @shreyakapoor08 For this issue we should try to proceed as follows:

  • For License ,Code of Conduct,Contributing Guidelines:just add them in them in the main page of documentation with a line or two for each. Also, a redirect to the files on the master branch of the repo

  • For testing purposes, anyone of you just take out the required html,css files and the associated assets and push it to the docs folder on the master branch.

  • For hosting guide I would prefer to have a wiki on this repo rather than putting in the docs

  • If you want to add other wikis, you can write on:
    - Deploying to Netlify (Detailed Process)
    - Using GitHub CLI (Not the Git bash we use)
    - SEO Tips (@anushbhatia is a resourceful person for this)

  • The majority of the work to generate a v.0.0.1 for docs of this project is over. So two important things that we need to work on is:
    - Improve the style of the documentation(there are blogs online or if you wish you can write a custom.css file)
    - Update the documentation as per changes in code every 3-5 days

  • 👍1