Migrate documentation to inside the repository

JSRocksHQ / harmonic

The next static site generator

http://harmonicjs.com/

MIT License

282 stars 26 forks source link

Migrate documentation to inside the repository #181

Closed UltCombo closed 8 years ago

UltCombo commented 8 years ago

I'm considering to migrate the docs from the Wiki to inside the main repository.

Sindre Sorhus has laid some interesting points for this. I believe the main point is that having the docs inside the repository would enable us to update the documentation and review it in the same pull requests that add or modify behavior, thus making it much easier to update and maintain the docs.

What do you think?

jaydson commented 8 years ago

Totally agree. Let's go forward with this.

UltCombo commented 8 years ago

Great. :)

My plan is:

Clone the Wiki repository (https://github.com/JSRocksHQ/harmonic.wiki.git) and put its contents in a doc directory, fixing relative links as needed.
Edit the Wiki pages to link to the main repository's doc directory and lock down the Wiki to contributors only, in order to avoid misplaced contributions from the public that would be missed.

jaydson commented 8 years ago

That's sounds like a good plan :+1:

jaydson commented 8 years ago

:sunglasses:

UltCombo commented 8 years ago

I'll update the Wiki pages to link to the new docs after fixing the P1 issues.

UltCombo commented 8 years ago

The Wiki now links to the Harmonic repository's docs.

jaydson commented 8 years ago

Awesome, thanks @UltCombo !

UltCombo commented 8 years ago

Yay, new docs!