stellarfw / stellar-framework.com Goto Github PK

Is there a way to edit the current stellar-framework.com home page? (The one with the mailing list signup form.)

I would revise the text as follows:

Stellar is a framework for developing Web APIs easily. Stellar was created to address the main flaws of current frameworks, using a new paradigm to facilitate maintenance, scalability, and performance.

Stellar is an action-based web framework which includes a set of tools that make it easy to quickly prototype your new Web API and then scale it to enterprise level.

We most write a simple "tutorial" to show how new developers can create their own apps using Stellar.

In events.md - it mentions a stellar generateEvent command but the stellar tool doesn't seem to support this at all:

$ stellar --help
> Stellar Framework version 1.0.1

Available commands:
 makeAction               Create a new action file
 makeModel                Create a new model
 makeTask                 Create a new task
 run                      Run a Stellar instance
 cluster                  Create a custer
 init                     Create a new Stellar project
 help                     show the command description

It seems like it would probably be stellar makeEvent for consistency with the other commands, but that doesn't seem to exist either.

This issue is in both the English and Portuguese versions of the documentation.

Some of the methods documented in tasks.md don't appear to exist in the actual Stellar framework source code:

• delQueue
• stats
• delDelayesAt (this looks like a typo, but I'm not sure what the intended method name was)

The documentation talks about the stellar startCluster command (this is the case for both the English and Portuguese versions) but the actual command seems to be stellar cluster. I'm not sure if the documentation should be fixed to match the command or the command should be fixed to match the documentation.

In actions.md - sometimes the property convertTo is used, sometimes convert is used (I'm not sure which one it is supposed to be). This is the case in both the English and the Portuguese versions.