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

[29/01/23] Project documentation - Setup/Introduction #184

Merged

Conversation

RealRichi3
Copy link
Member

@RealRichi3 RealRichi3 commented Jan 29, 2023

Summary

Create technical documentation for project

Partially Fixes #151

Lorem ipsum dolor sit amet, consectetur adipiscing.

List of changes proposed in this PR (pull-request)

  • Create technical documentation for project
  • Add necessary tutorial files
  • Complete doc homepage
  • Add contribution guides
  • Add NEXT button feature

@the-label-bot the-label-bot bot added kind/documentation kind/documentation size/XS size/XS labels Jan 29, 2023
@the-label-bot
Copy link

the-label-bot bot commented Jan 29, 2023

The Label Bot has predicted the following:

Category Value Confidence Applied Label
Kind documentation 0.943 ✔️
Kind XL 0.796 ✔️

@RealRichi3 RealRichi3 added the inprogress PR is still work in progress label Jan 29, 2023
@the-label-bot the-label-bot bot added size/M size/M and removed size/XS size/XS labels Jan 29, 2023
@the-label-bot the-label-bot bot added size/L size/L and removed size/M size/M labels Jan 31, 2023
@the-label-bot the-label-bot bot added size/XL size/XL and removed size/L size/L labels Feb 4, 2023
@RealRichi3 RealRichi3 changed the title [29/01/23] Project documentation [29/01/23] Project documentation - Setup/Introduction Feb 4, 2023
@RealRichi3 RealRichi3 removed the inprogress PR is still work in progress label Feb 4, 2023
@RealRichi3
Copy link
Member Author

@sandygudie please how did you create the netlify preview for the blog site, i'd like something similar for the code documentation

@RealRichi3
Copy link
Member Author

I have completed the introduction, usage and getting started guide

@sandygudie
Copy link
Member

Welldone Richie
You would have to open an account with Netlify to deploy projects there.
I don’t mind doing it from my account if needed

Also you could try GitHub pages if the folder containing the work is in the root folder

Let me know which one suits you

@RealRichi3
Copy link
Member Author

Welldone Richie You would have to open an account with Netlify to deploy projects there. I don’t mind doing it from my account if needed

Also you could try GitHub pages if the folder containing the work is in the root folder

Let me know which one suits you

Thanks @sandygudie I'll open the netlify account

@BatoolMM
Copy link
Member

BatoolMM commented Feb 7, 2023

Thank you, Sandy!

Yes, let us know if GH pages can be an easier option!

@RealRichi3 RealRichi3 merged commit db75140 into Open-Science-Community-Saudi-Arabia:dev Feb 8, 2023
RealRichi3 added a commit to RealRichi3/MOOCs that referenced this pull request Feb 20, 2023
@RealRichi3 RealRichi3 deleted the project_doc branch March 10, 2023 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation kind/documentation size/XL size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants