smaranjitghose / awesome-portfolio-websites

A community maintained open source project aimed at making a personal portfolio for researchers, developers, and analysts simple, fast, and less cumbersome. We make sure you have a full-fledged website to showcase your work while you can spend time on your learning and innovative endeavors.

https://portfolio.smaranjitghose.com/

MIT License

2.37k stars 1.5k forks source link

Documentation #12

Closed smaranjitghose closed 4 years ago

smaranjitghose commented 4 years ago

Preference 1 : Sphinx
Preference 2: Docusaurus

siddhiisonii commented 4 years ago

@smaranjitghose sir please assign me this

smaranjitghose commented 4 years ago

@smaranjitghose sir please assign me this

Try experimenting with Docusarus or Sphinx and let me know which is more easier for you

siddhiisonii commented 4 years ago

@smaranjitghose okay sure sir

SKV-programmer commented 4 years ago

Hi @smaranjitghose , could you please assigned me this section

smaranjitghose commented 4 years ago

@SKV-programmer @siddhiisonii

My Suggestions:

Collaborate on Slack
Learn Sphinx
One of you give a pr to a docs branch ( Let me know before you do I'll create it) with only the basic documentation files and other necessary stuff from the master branch ( LICENSE, README, Code of Conduct)
The other one give a PR with an MD file on how to set up documentation ( sort of a mini-blog post)
Divide the 6 pages we have among yourself
For each of the page, write an elaborate description of the sections and what lines to change in what files so that anyone with zero knowledge of web dev can read the docs, clone this repo, do the changes and setup their own portfolio within 30 min or less

Does this sound good?

Let me know when should I expect both of your first PR on this issue

anushbhatia commented 4 years ago

Did u guys start any progress?

SKV-programmer commented 4 years ago

Ya we are working on it

anushbhatia commented 4 years ago

okay try to give a basic sphinx code in a new branch

KanhaMishra25 commented 4 years ago

can I learn sphinx sir and give basic codes.. I can learn something new by this

smaranjitghose commented 4 years ago

can I learn sphinx sir and give basic codes.. I can learn something new by this

Okay, colab with @siddhiisonii and @SKV-programmer and distribute the work.

KanhaMishra25 commented 4 years ago

sir.. Deeply sorry for the late reply. Actually my PC is not working and gone for repair. Will take 2 days.. I am replying this from my phone. Hope you understand sir.

On Sun, Aug 23, 2020 at 7:20 AM Smaranjit Ghose notifications@github.com wrote:

Assigned #12 https://github.com/smaranjitghose/awesome-portfolio-websites/issues/12 to @KanhaMishra25 https://github.com/KanhaMishra25.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/smaranjitghose/awesome-portfolio-websites/issues/12#event-3682453571, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOIRJ4TU244YCPOCTI4RUPLSCBYWFANCNFSM4N5OT5FA .

KanhaMishra25 commented 4 years ago

I will get in touch with Siddhi soni Today and will discuss about the portions to learn and implement.. Once again sorry for late reply

On Sun, Aug 23, 2020 at 3:19 PM Kanha Mishra kanhamishra555@gmail.com wrote:

sir.. Deeply sorry for the late reply. Actually my PC is not working and gone for repair. Will take 2 days.. I am replying this from my phone. Hope you understand sir.

On Sun, Aug 23, 2020 at 7:20 AM Smaranjit Ghose notifications@github.com wrote:

Assigned #12 https://github.com/smaranjitghose/awesome-portfolio-websites/issues/12 to @KanhaMishra25 https://github.com/KanhaMishra25.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/smaranjitghose/awesome-portfolio-websites/issues/12#event-3682453571, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOIRJ4TU244YCPOCTI4RUPLSCBYWFANCNFSM4N5OT5FA .

siddhiisonii commented 4 years ago

@KanhaMishra25 connect with me on slack and linkedin

SKV-programmer commented 4 years ago

I am sorry , I try to worked on Sphinx but faced some issues in that although I spend a lot of time in this section

smaranjitghose commented 4 years ago

@siddhiisonii @KanhaMishra25 Any updates?

KanhaMishra25 commented 4 years ago

I am watching some youtube tutorials regarding this as READ THE DOCS documentation is getting difficult for me to understand.

On Fri, Aug 28, 2020 at 4:40 PM Smaranjit Ghose notifications@github.com wrote:

@siddhiisonii https://github.com/siddhiisonii @KanhaMishra25 https://github.com/KanhaMishra25 Any updates?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/smaranjitghose/awesome-portfolio-websites/issues/12#issuecomment-682467313, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOIRJ4R2BDYOMKJEN7FADZLSC6GBVANCNFSM4N5OT5FA .

anushbhatia commented 4 years ago

If you face issues ask @smaranjitghose he will try to resolve your problems