Addon-docs: Naming consistency for Story blocks

[shilman]

As raised in @ndelangen 's review of #7119. We currently define stories in MDX as:

<Story name="some name">...</Story>

However, in the module format we can override the story title as:

export const story = () => ...
story.title = "some name"

Should we rename the Story's name attribute to title for consistency? Or rename title to name?

[tmeasday]

Or the other way (use name for both)

[shilman]

We run into a problem when trying to do:

export const foo = () => <Foo />;
foo.name = 'foo bar'

=> Cannot assign to read only property 'name' of function 'function(){return _ref2}'

New proposal:

export const foo = () => <Foo />;
foo.story = {
  name: 'foo bar',
  parameters: ...
};

This is pure JS, allows us to stuff anything we want into story without worrying about name collisions, preserves "story name" which is widely used in storybook, and is only slightly more verbose.

[shilman]

Whoopee!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.2.0-alpha.31 containing PR #7202 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there's still more to do.