Where to write project documentation online?

1

I am making a project that is constantly improving feature wise.
I want to write an online documentation where future employers can easily see how my project is being built.
From the 1st version that is bare bone, to the next version where I build everything from ground up, to the next version where I perfect every details and make the site responsive.

Github README is a perfect place to host something like this, but I’ve created multiple repos for the project.
Where do you guys store your documentations online? In your blog? Or ???

Should I create a standalone repo and turn it into a jekyll blog just for all the documentations I wrote?

2

Should I create a standalone repo and turn it into a jekyll blog just for all the documentations I wrote?

Yes that sounds like a good idea. Having a dedicated website is also good.

3

@zhouxiang19910319 have you tried using github’s wiki feature? I suppose one way of documenting your process is to create a series of pages there.

I’ve also seen larger projects create a separate repository / project for their documentation (you can use github pages to host them as well)

1 Like
4

yeah, this is what I did. I used github pages as well as jekyll basically built a static site.
Thanks for the suggestions guys.

@JohnnyBizzel @JoelLau

1 Like