We have release a sample Foreign Exchange trading platform to our GitHub and it makes full use of Seneca. Links to the live demo are on our website

thecitysecret ltd

Store plugins usually provide a common interface to access the underlying module handling storage. We need a tutorial explaining how this works with a number of our popular stores. I suggest:

• leveldb
• mysql
• mongo

title says it all

We need to update the contribution section here to point to the new repo once it's ready. cc// @geek

It's not a great experience right now.

We are missing summaries for all methods in the API doc. We need to get this completed as soon as possible even just enough to round out what is there.

The getting started guide is excellent, one of the best Image read.

It would-be really usefull to go the next step you hint at and outline how you might use Docker. Also an outline full microservices dev. and deploy workflows would be a great help.

Or maybe that is the subject for blogs or a book? :)

We need to explain Patterns better

• remove tagline
• update vectors
• update site footer
• update repo links

Add in 'Seneca' Icon to places it was missing.

I'd love to get your opinion about hosting on surge.sh. It is a free hosting service and supports CNAME, essentially the exact same as GH-Pages. There are two key differences though.

1: Docs can be much cleaner, we can output to a /dest folder and then run npm run deploy to push them to surge. The overall experience of working with the repo would massively improve.

2: Like npm Surge has a whitelist of people who can publish, this can be different from code contributors for whatever reason. The extra layer of security is a nice bonus.

To enable surge is as simple as downloading the CLI and setting up an account through it, 20 sec turn around time. After that you can specify which email address can push to your site. Adding a command to the package.json is handy too.

 // change to senecajs.org when cnamed
"deploy": "surge --project ./dist/ --domain seneca-docs.surge.sh"

Also note that we can use Travis to auto push too, if that's your thing.

The link to documentation on the pin api resolves to a 404: http://senecajs.org/api/desc-pin-pattern-format when attempting to access it from http://senecajs.org/api/

Let me know if there is anything I can do to help.

Couple of questions have been fielded on this and answered pretty much the same way. It would be helpful to get a small article on this. See senecajs/seneca#202 for context.

Integrate Algolia for better search doc experience:

cf: https://community.algolia.com/docsearch/

(currently in contact with an algolia team member :) )

Something not right here, they are not indented properly.

It would be nice if for each example or documentation for API was indicated version of the library. The usual case where documentation was not updated with new versions of the library. Maybe you can specify which version of the library has been written documentation?

lots of good stuff there for learning

Very minor: in the 'writing microservices' section of http://senecajs.org/get-started/, it states:

... to the math-service microservice above, which then responds with:
{ "answer":2 }

And I believe it should be 3, not 2.

The "Live Logs in Your Browser" sample here http://senecajs.org/tutorials/logging-with-seneca.html has a line like this
var server = http.createServer(seneca.service())
I'm getting this error when trying to run it.

var server = http.createServer(seneca.service())
                                      ^
TypeError: undefined is not a function
    at Object.<anonymous> (/root/seneca/test.js:8:39)
    at Module._compile (module.js:460:26)
    at Object.Module._extensions..js (module.js:478:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Function.Module.runMain (module.js:501:10)
    at startup (node.js:129:16)
    at node.js:814:3

Hi,
I'm running the following code in MAC - works OK.
When running it on windows 7 - the following error occurs..

function color() {
  this.add( 'color:red', function(args,done){
    done(null, {hex:'#FF0000'});
  })
}


var seneca = require('seneca')


seneca()
  .use(color)
  .listen({type:'tcp'})

seneca()
  .client({type:'tcp'})
  .act('color:red')

// node readme-color-tcp.js --seneca.log=plugin:transport,level:INFO --seneca.log=type:act,regex:color:red

• same for http transport
• firewall was disabled...

The Error:
2015-10-15T09:14:46.808Z s3fx6o3a4jgi/1444900486776/7384/- DEBUG act remote$ IN m9bqsfq0d1ms/mj7vu98io1jj
{color:red} ENTRY CLIENT - - -
2015-10-15T09:14:57.946Z s3fx6o3a4jgi/1444900486776/7384/- ERROR act remote$ OUT - 11135 {color:r
ed} ENTRY CLIENT - seneca: Action failed: [TIMEOUT]. act_execute {id:m9bqsfq0d1ms/mj7vu98io1jj,gate:false
,ungate:false,desc:,plugin:{name:remote$,tag:null},time:{start:14449004 Error: [TIMEOUT]
at null._onTimeout (C:\seneca\node_modules\seneca\node_modules\gate-executor\gate-executor.js:95:
21)
at Timer.listOnTimeout as ontimeout

Thanks,

In cases where a store plugin uses a native driver under the hood, Seneca provides the ability to access these drivers. We need a Tutorial explaining the most common stores and provide examples.

Bonus points if you update the README's with an example on a per store basis. Each repo already has a section awaiting this info.

Trello Card

A tutorial documenting Seneca's query syntax is needed. See below for example:

• .list$({f1:v1, f2:v2, ...}) implies pseudo-query f1==v1 AND f2==v2, ....
• .list$({f1:v1,...}, {sort$:{field1:1}}) means sort by f1, ascending.
• .list$({f1:v1,...}, {sort$:{field1:-1}}) means sort by f1, descending.
• .list$({f1:v1,...}, {limit$:10}) means only return 10 results.
• .list$({f1:v1,...}, {skip$:5}) means skip the first 5.
• .list$({f1:v1,...}, {fields$:['fd1','f2']}) means only return the listed fields.

Try to use a plugin with a wrong syntax:

module.exports = function( seneca, options, callback )

Seneca will die with following message:
.....
ns, callback ) { ... }. The correct format is: function(options) { ... }. For more details, please see http://senecajs.org/write-a-plugin.html

The url for details is not valid, it sends to 404 page.

I think it should be
http://senecajs.org/tutorials/how-to-write-a-plugin.html

We have a number of documentationcontributors now, they should be listed on a page and in the package.json

Hi, as part of my work in rewriting seneca-store-test I'm going to put together a brief guide on how to build a store.

However, there are a couple of things that are a bit obscure to me, and would be helpful if someone can explain me so that I can add that to the guide.

The first thing I encountered is the ceremony needed to register a store, something like:

  var meta = seneca.store.init(seneca, opts, store);
  desc = meta.desc;
  seneca.add({ init: store.name, tag: meta.tag }, function (args, done) {
    setup(opts, done);
  });

This is common among many of the current stores, but I'm not sure why is seneca.store.init needed and what it actually does, what is the meta object returned, and what's the need for the "init command" registered into seneca.

I'm also wondering if we are open to change and simplify this part of the api.

cc @mcdonnelldean @geek @rjrodger

Trello Card

on page *understanding-data-entities:

 [guide to writing data store plugins]: /data-store-guide.html

Need to add CSS to fix this.

A lot of people new to Seneca are getting tripped up managing how to layer services together. A tutorial taking a few services that interact with each other and discussing strategies for composition will help.

Where should they point?

• http://senecajs.org/entity-canon-format
• http://senecajs.org/api/desc-pin-pattern-format

(i'll fix it and make a PR :))

Hi,

if you try to click over "Dealing with Options" in seneca plugin tutorial page (http://senecajs.org/tutorials/how-to-write-a-plugin.html,) the page doesn't scroll to the proper position.

lots from me obviously, but also a few others
would really help people to get wider context

Seneca to Seneca or Seneca to transport has various bits of documentation. We are missing a solid tutorial on talking to a Seneca powered microservice via the browser. A good Rest tutorial would be awesome here.

Should discuss different approaches, including https://github.com/rjrodger/seneca-jsonrest-api

Link to samples page on /tutorials page shows 404 on Github.

code layout a bit off, needs more examples

Trello Card

Following the issue https://github.com/rjrodger/seneca/pull/188 ,

looks like the $default option when a seneca client use the act method but no action pattern match the request is not documented.

The behavior is that if $default is an object ( or an array when is merged, https://github.com/rjrodger/seneca/pull/188 ), and no worker match the pattern asked, then $default will be return, as if if was returned by a worker.

This can probably be solved in the same time as #11

Trello Card

Right now the headings, menus and other large fonts are jaggy. We need to look at this and see can we improve it either by swapping the font or moving to a heavier set.

cc @AdrianRossouw

We've had a couple of questions on this so a guide with common recipes needs to be created.

A lot of images in the /images folder are uneeded. We need to purge these.

From: senecajs/seneca#93

• Move document over (https://github.com/senecajs/seneca/blob/master/doc/transport.md)
• Flesh out
• Have language reviewed.

Trello Card

Many Documentation guide have to be written.

Might be a good idea to determine which one are the most urgent so that we focus our attention on tehm.
Idea would be to mark them with a dedicated label, after we identify them with a discussion.

(tags to distingate between: core, user(use seneca), contributor(extend seneca), guide, tutorial might also be usefull)

What do you think?
@geek @rjrodger

The remainder of http://senecajs.org/getting-started.html needs to be copied into the get-started/index.md

Hi,

Guys, can you post some example with seneca, hapi and socket.io ?

Cheers,

Michał

I was going to create a pull request, but then I realized I had some trouble finding the corresponding files so I decided to open an issue instead/first.

So, apparently, the tutorial pages contain some links that lead to the old version of the website which now simply throw 404s (if that is even the page that is being used to generate the tutorials from). It is not so hard to find which links are troublesome since they are nicely left at the bottom of the .md pages, but the thing is that some of the lead to specific anchors. For instance, the first link at the bottom of how-to-write-a-plugin.md which looks like this http://senecajs.org/api.html#long-m-add. The anchor is absent and I couldn't actually find where the "api" pages is being generated from so I could create a new one.

P.S. There is also an extra closing square bracket at the end of the link called "Seneca Examples" in the tutorials index.

For some reason the Favicon hates me. We have the assets but just need to apply them correctly. Anyone have any thoughts on this?