First cut at documentation of project arg/argTypes for discussion

[tmeasday]

Issue: #11697

What I did

• Added a section on project-level args to the args page
• Created an example (perhaps not a very good one) of what you might use it for.

What we need to figure out:

1. What's a good example of a project-level arg?
2. Do we even want to talk about project-level args without figuring out and documenting (arg targets Args: Add ability to specific argType "targets" #16333)
3. How can we document project-level argTypes? Should we be talking about story-level argTypes also?

[nx-cloud]

☁️ Nx Cloud Report

CI ran the following commands for commit 03279e0. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 1 target

• nx run-many --target=prepare --all --parallel --max-parallel=15

---

Sent with 💌 from NxCloud.

[shilman]

I think the preview.js example should be in snippets/common. Otherwise LGTM!

Also we should fix the implementation so that it works in both storyStoreV7 and legacy modes

[jonniebigodes]

Looks good to me! And indeed the snippet should be placed in the common directory.

[kylegach]

I personally like the clarity of "project" rather than "global" here, but we currently use the term "global" for parameters and decorators.

[tmeasday]

Yes! We changed this internally in 6.4, as it was super confusing to have "global args" and "globals" (which once upon a time were actually called globalArgs haha).

We should transition to using project everywhere I think. What's your recommendation in the meantime?

[kylegach]

I think this PR should use "global". Then we can make another PR to update it to "project" everywhere, possibly only including that change in 6.5+.

[kylegach]

Perhaps we should add similar docs for argTypes to https://storybook.js.org/docs/react/api/argtypes?

[jonniebigodes]

@kylegach sounds reasonable to me!

[tmeasday]

Yeah, I got a bit hung up on the fact that we don't actually document story-level argTypes there (I guess argTypes at the story level generally speaking don't make a heap of sense, although it can be done). But I'll add something.

[tmeasday]

OK, thanks all, I think this is ready now, perhaps pending #17043

[IanVS]

Looks like #17043 was merged. Is this good-to-go now, then?

[shilman]

@IanVS @tmeasday we still need to move the snippet to the common directory

[codecov]

Codecov Report

Merging #16992 (3dcff54) into next (3e5d660) will not change coverage.
The diff coverage is n/a.

❗ Current head 3dcff54 differs from pull request most recent head 03279e0. Consider uploading reports for the commit 03279e0 to get more accurate results

@@           Coverage Diff           @@
##             next   #16992   +/-   ##
=======================================
  Coverage   32.23%   32.23%           
=======================================
  Files         939      939           
  Lines       18405    18405           
  Branches     3836     3836           
=======================================
  Hits         5932     5932           
  Misses      11997    11997           
  Partials      476      476           

---

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 3e5d660...03279e0. Read the comment docs.

[jonniebigodes]

Looks good to me @tmeasday! Thanks for taking care of the snippets. Going to merge this @shilman !