Add hierarchySeparator to README

[joscha]

Add hierarchySeparator example.

[shilman]

@joscha @igor-dv @ndelangen vote for '/' as the one we push users towards. And I think Norbert doesn't even want it to be configurable?

[codecov]

Codecov Report

Merging #1445 into release/3.2 will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           release/3.2    #1445   +/-   ##
============================================
  Coverage        20.36%   20.36%           
============================================
  Files              236      236           
  Lines             5136     5136           
  Branches           634      721   +87     
============================================
  Hits              1046     1046           
+ Misses            3609     3546   -63     
- Partials           481      544   +63

Impacted Files	Coverage Δ
addons/storyshots/src/storybook-channel-mock.js	0% <0%> (ø)	⬆️
app/react-native/src/bin/storybook-build.js	0% <0%> (ø)	⬆️
app/react/src/client/preview/error_display.js	0% <0%> (ø)	⬆️
app/react-native/src/bin/storybook-start.js	0% <0%> (ø)	⬆️
addons/knobs/src/components/types/Number.js	8.06% <0%> (ø)	⬆️
lib/ui/src/modules/ui/libs/hierarchy.js	47.16% <0%> (ø)	⬆️
lib/ui/src/modules/ui/configs/init_panels.js	25% <0%> (ø)	⬆️
...codemod/src/transforms/update-organisation-name.js	40.62% <0%> (ø)	⬆️
addons/info/src/components/Node.js	39.43% <0%> (ø)	⬆️
lib/ui/src/modules/api/configs/init_api.js	40.47% <0%> (ø)	⬆️
... and 14 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0121a7c...fdcacc8. Read the comment docs.

[joscha]

I am fine either way - I have a preference for ., but can arrange myself with anything else as well :)

[igor-dv]

At the current project I am working on, we use '.' syntax, that actually was inspired by this. But there is nothing tragic to change it.
(Maybe worth it to change the docs as well)

@ndelangen why not to expose this as a setting ?

[ndelangen]

Having it configurable makes life more difficult for us in the long run.

Imagine webpack inline-loaders-syntax being configurable, what a mess that would quickly turn into.
We need to be careful to add special syntax into a string. It needs to make sense.

I don't think it makes a whole lot of sense to make this configurable other than, in 1 documentation-page we advocate for another character.

From what I hear everyone is actually OK with the / character, but some slightly prefer a .

I think we need a good why to increase the api-surface.

How about this: I'll do a poll on twitter

[joscha]

How about this: I'll do a poll on twitter

sounds good to me!

[ndelangen]

https://twitter.com/storybookjs/status/884749480259710976

[joscha]

One question that just occured to me - dots have been advocated a while: https://storybook.js.org/basics/writing-stories/#prefix-with-dots that's why we initially chose them. Has that changed? Is there special logic anywhere to do matching against dots in the search?

EDIT: fuse.js seems to be fine with any separator...

[danielduan]

Is there a middle ground we can go for? maybe / as default with an option for ., -, or _?

I can definitely see this getting messy with i18n, especially if things like the East Asian periods and Arabic reversed commas.

[ndelangen]

Let's just go for it.

Please change default to /

[joscha]

changed to /, however in docs only.

[igor-dv]

I'll add the default in code later today/tomorrow

[shilman]

Merging and leaving @igor-dv for the code followup 👍