NodeOS / NodeOS

Lightweight operating system using Node.js as userspace

Home Page:http://node-os.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs

piranna opened this issue · comments

The new website has a copy of the docs extracted from the wiki. There is a project to port them and generate them as a GitBook, but also there was discussions to merge that project with the main one on a docs/ folder and serve them from there, so what could we do? I propose this last thing, and make the website to redirect to the website of the docs, maybe at docs.node-os.org, what do you think?

im also for the docs/ folder

For ref, the docs project is at https://github.com/NodeOS/docs. It would be just enough to move all its content to a docs/ folder to avoid conflicts, set it as remote of this main repo, and pull it to have them both merged in their correct place.

commented

the docs/ folder sounds pretty good to me.

Ok, I have merged the docs on the docs/ folder and published them... and found some interesting things. Since we have alreade a nodeos.github.com project hosting the main web site, all the projects web pages of the NodeOS organization are under the node-os.com domain, so this main repo (and its docs folder) are at http://node-os.com/NodeOS/ just by free. Point is, taking this in account we could still have the docs project and it would be automagically available at the correct URL, so now I'm not sure what we should do:

Hmm. I have always found it convenient to have the docs in the main repo. It's nice to have it locally when getting into a new repository.
However, the /docs url is better i think. But I don't think that the url should determine it alone.

Maybe we should consider what and how much documentation, that we want to have (At least for now). Currently there is a nice separation of NodeOS, and after all it is an OS, so there will plenty to write about.
So maybe I would consider the docs big enough to be in its own project.