search

goaltools / goal

Goal is a toolkit for high productivity web development in Go language in the spirit of Revel Framework that is built around the concept of code generation.
BSD 2-Clause "Simplified" License
87 stars 3 forks source link

Document every tool #6

Closed ghost closed 9 years ago

ghost commented 9 years ago

Manual lives here. The docs are for MVP but they are still valid. Every tool here must have their own README.md as follows:

And we can have a list and short descriptions of all supported tools in the root README.md.

davidhunterxyz commented 9 years ago

Shouldn't this be at it's own repository?

ghost commented 9 years ago

@DavidHunter Well, I don't know. Probably.

The idea was to simplify user's reading of code by providing a README for every subpackage in the repo. That would also help to keep the docs up-to-date: if you're contributing something, you're making changes not only to code, but also to the appropriate README.

But on the other hand, that would require maintaining two versions of docs: in this repo and web-site. And that looks like overkill.

What do you think? Separate repo?

davidhunterxyz commented 9 years ago

I looked at other open source projects and they have them in separate repo or its in the website repo.

Mongodb has docs in a separate repo. You can git clone it and build a local html version. I think that is a nice feature.

ghost commented 9 years ago

OK, let's use a separate repo then.

davidhunterxyz commented 9 years ago

It also depends on what you have planned for Colegion. Will you be building other products other then Goal toolkit?

ghost commented 9 years ago

@DavidHunter Yes I will.

davidhunterxyz commented 9 years ago

We can have the docs in the projects repositories then just parse the docs in each project for the Colegion website.

ghost commented 9 years ago

I will support any your decision regarding this issue.

ghost commented 9 years ago

@DavidHunter Are you still around and interested? If not I'm going to follow my initial plan.

davidhunterxyz commented 9 years ago

I am still around. Been busy with some stuff. I like the way you are doing things. I want to support your plans.

ghost commented 9 years ago

@DavidHunter Great.

I'm closing this issue as we have already had some sort of documentation for every of the tools. Now we need to work on the quality of the documentation + probably redesign the web-site (orange color, icon with the Sun, etc. is all a legacy of the previous project's branding). Let's open new issues to discuss that.