Document code structure in root readme #2220
Conversation
markfields
requested review from
skylerjokiel,
curtisman,
tylerbutler,
nmsimons and
anthony-murphy
| * [Packages](./packages) | ||
| * [Example Components](./components/examples) | ||
| * [Experimental Components](./components/experimental) | ||
| * [Example host](./examples/hosts/iframe-host) |
There was a problem hiding this comment.
This is a prototype for hosting in an iframe, i would put this below with other example hosts
There was a problem hiding this comment.
But for some reason it's included in the client minirepo lerna.json. @curtisman
There was a problem hiding this comment.
@anthony-murphy - Actually looks like you're the one who added it to lerna.json. Was there a reason you wanted it building/versioned with packages instead of standing alone?
https://github.com/microsoft/FluidFramework/pull/1328/files#diff-52d4bf43db96176e77cc9038a78f98e1
| @@ -1,3 +1,3 @@ | |||
| # Fluid Common Definitions | |||
|
|
|||
There was a problem hiding this comment.
nit: I would prefer "Sentence casing" instead of "Title Casing". But really, shouldn't this be the name of the package itself?
There was a problem hiding this comment.
Yeah I like using the package name. Once we rev our package names to use the @fluidframework scope I'll make a pass and ensure there's a readme alongside every package.json with the package name as the title.
|
@tylerbutler - Happy to drop in any copy you send me, I just didn't want to block/hold myself up on trying to write words. |
Working on #1879
All the links in that tree go to directories with a readme, but some/many of those need to be updated still.
What do you think of how this info is presented? Looking for lots of feedback!