ZigRazor / CXXGraph

Header-Only C++ Library for Graph Representation and Algorithms
https://zigrazor.github.io/CXXGraph/
Mozilla Public License 2.0
442 stars 107 forks source link

Website Development For Project #213

Open ZigRazor opened 1 year ago

ZigRazor commented 1 year ago

Now that the project have a good visibility, we need a new interface with the Public. So we need a new WebSite for the project that for the moment will be delivered in the github-pages. We need an attractive interface and a section with the documentation. The in a second moment we can move the algorithms details in a site page.

iks1 commented 1 year ago

can i work on this ?

ZigRazor commented 1 year ago

yes, obviously! I give you the possibilities to select best design for the site. good work

ZigRazor commented 1 year ago

@iks1 are you working on it?

ZigRazor commented 1 year ago

Deassigned due to inactivity

iks1 commented 1 year ago

hello, I was busy on another work, Since I am free right now , I want to devote some time working on it . If you are okay can we discuss about it . So here are some questions . Do you want it to initialize the website folder in this repository itself or you want to initialize an another repository ? And I was thinking of using React for this project let me know if you are okay with it , we can deploy it on vercel easily

iks1 commented 1 year ago

if you are okay i can start toady itself

ZigRazor commented 1 year ago

Yes, it's ok. I think on this repo, if possible with github pages also react is ok. The branch is gh-page

iks1 commented 1 year ago

okay then working on it , please reassign

iks1 commented 1 year ago

if you want i want to share to some samples of documentation websites , let me know which one you want , and @ZigRazor can you please let me know what are the things that you need in your website ? For now I will make a basic structure website and and its contents and will share with you in a while .

ZigRazor commented 1 year ago

Yes, I appreciate the show of samples. So we can choose the best for this kind of project. Thank you in advance

iks1 commented 1 year ago

okay on it @ZigRazor one more thing is the branch gh-pages already deployed ? cause It is showing errors when I try to run in in locally.

ZigRazor commented 1 year ago

Yes, the branch is deployed, the site can be visited from github pages

iks1 commented 1 year ago

when I try to run the site locally I am getting the error @ZigRazor could you please help ! image

iks1 commented 1 year ago

@ZigRazor according to me there should be some key points like

  1. What it is and how to install
  2. Different functions and explaining how they work what they are and how to use the different algorithms using some sample codes like this one which is for dijkstras image

And for the documentation I think the layout should be something like this , consisting of three columns, middle one the main content, left side bar the name of topics and right one the related topics , just like the microsoft STL documentation image

And the left side bar should have subtopics similar to this image Please let me know your views on it .

ZigRazor commented 1 year ago

when I try to run the site locally I am getting the error @ZigRazor could you please help ! image

I don't know why? look at the deployed site: https://zigrazor.github.io/CXXGraph/

ZigRazor commented 1 year ago

@ZigRazor according to me there should be some key points like

  1. What it is and how to install
  2. Different functions and explaining how they work what they are and how to use the different algorithms using some sample codes like this one which is for dijkstras image

And for the documentation I think the layout should be something like this , consisting of three columns, middle one the main content, left side bar the name of topics and right one the related topics , just like the microsoft STL documentation image

And the left side bar should have subtopics similar to this image Please let me know your views on it .

All correct! the idea is beautiful. I think this is the kind of site we should have on this project!

iks1 commented 1 year ago

@ZigRazor can we have meet regarding this, I want to clear some things... Maybe on discord ? Please let me know

iks1 commented 1 year ago

@ZigRazor also if this design is final I would like to start the work and would request please create a new branch so that I can start working on it without effecting the current hosted branch also considering that current one is not working on my local machine.

ZigRazor commented 1 year ago

@ZigRazor can we have meet regarding this, I want to clear some things... Maybe on discord ? Please let me know

@iks1 I think is better mantains the discussion here, to let all aware about the decision taken.

ZigRazor commented 1 year ago

@ZigRazor also if this design is final I would like to start the work and would request please create a new branch so that I can start working on it without effecting the current hosted branch also considering that current one is not working on my local machine.

I create the branch new-website for this task!

iks1 commented 1 year ago

@ZigRazor also if this design is final I would like to start the work and would request please create a new branch so that I can start working on it without effecting the current hosted branch also considering that current one is not working on my local machine.

I create the branch new-website for this task!

okay , starting to work on it then ... do you have any specific preference for tech stacks ? if not I am initializing the React + Typescript website on that branch

ZigRazor commented 1 year ago

No, I don't have specific preferences about the tech stacks, the oly requirements is that works on github pages.

iks1 commented 1 year ago

No, I don't have specific preferences about the tech stacks, the oly requirements is that works on github pages.

okay , I am starting then

iks1 commented 1 year ago

@ZigRazor initialized the website in website folder [https://github.com/ZigRazor/CXXGraph/pull/330](Pull Request), please merge it .

ZigRazor commented 1 year ago

@iks1 Idon't know if you have already seen, but I have merged your PR

iks1 commented 1 year ago

@iks1 Idon't know if you have already seen, but I have merged your PR

Yeah I did , working on it, I was finalising some layout ... Will resume the work soon