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

Wiki on web development in Go language #31

Open ghost opened 8 years ago

ghost commented 8 years ago

We need to work on the quality of our docs:

Moreover, I propose to change the target audience we are trying to address. Not the Go web developers but those who have no experience with Go language and/or Web Development at all. The former is a pretty small group with already shaped preferences and tastes. We can attract fresh blood instead: people from other stacks and backgrounds.

What we need:

davidhunterxyz commented 8 years ago

@alkchr Is the layout and navigation at https://colegion.github.io/goal/manual/index.html not good enough? Do you want to build upon the current site or do you have something else planned?

ghost commented 8 years ago

@DavidHunter The manual doesn't look super friendly for newcomers, does it? Though I haven't thought about the manual in details yet. The about page is what concern me the most, it definitely needs a redesign. It doesn't give a feel what it's like to use Goal. A few code fragments are required, e.g.:

// App is a sample controller.
type App struct {
    // Import of Accounts controller and mounting of its
    // actions to "/accounts".
    *Accounts `@route:"/accounts"`
}

// Greet is a demo action that gets a name and greets you.
//@get /hello/:name
func (c *App) Greet(name string) http.Handler {
    c.Context["name"] = name
    return c.Render()
}

Or some other variations that would show:

And that must be somehow combined with the information about code generation, hot reloading, type safety, compatibility with the standard library, customizability, etc. The goal is to let a user coming from HN or whatever site where a link is published easily grasp the value he/she gets without reading manuals and visiting GH repo. Now there are only gibberish words with no proofs (replace "Goal" by "{FRAMEWORK_NAME}" and nothing will change).

Other tasks:

As for your last question, the new site will be located at https://github.com/goaltools/goaltools.github.io. We could move gh-pages branch of colegion/goal to that repo. I am however not sure that worth it. The current docs are very outdated (goal run info is the only actual one). By the time of v0.02 release, it will contain no up-to-date info at all. So, why not use a new template & style for the new site by starting from scratch?

davidhunterxyz commented 8 years ago

@alkchr Where did you get the website template from? Do you want to use the same template?