Conversation
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 69.6%, saving 56.3 KB.
|
📚 Mintlify Preview Links✨ Added (1 total)📄 Pages (1)
📝 Changed (1 total)⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
…into weave/projects-assets
docs.json
Outdated
| }, | ||
| { | ||
| "group": "Enterprise", | ||
| "group": "Platform", |
There was a problem hiding this comment.
Should this stuff be moved over to the /platform docs?
mdlinville
left a comment
mdlinville
left a comment
There was a problem hiding this comment.
Several small suggestions, and some feedback about the navigation, but this is a great addition.
| { | ||
| "group": "Tools & Resources", | ||
| "pages": [ | ||
| "weave/guides/platform/weave-projects", |
There was a problem hiding this comment.
This new page seems either oddly placed and/or oddly titled. It's too bad there are not more pages about projects, but how about just "Weave projects" fore a title?
There was a problem hiding this comment.
Yeah, I completely agree. I really couldn't find a better place to shoe-horn this in using the current IA. The IA desprerately needs work for stuff like this. I'm kinda stuck between a rock and hard place, because I have tickets that require this coverage, but the IA needs a huge amount of rework that requires not just reorganizing pages, but breaking them out in places and consolidating in others. It's a mess.
I'll think of something to do here.
| @@ -0,0 +1,69 @@ | |||
| --- | |||
| title: "Weave projects overview" | |||
| description: "Weave projects are collections of traces, evaluations, models, and other Weave assets" | |||
There was a problem hiding this comment.
How about something like "Use Weave projects to organize related assets like traces, prompts, evaluations, models, and dashboards"? FYI the description also shows up at the top of the page content, so you may not need to duplicate it all in the first paragraph, depending on what you think about the preview.
| - **[Ops](/weave/guides/tracking/ops)**: Automatically versioned and tracked functions decorated with `@weave.op()` that produce calls and maintain a record of function modifications. | ||
| - **Other objects and metadata**: Additional Weave objects, custom types, and associated metadata stored within the project. | ||
|
|
||
| ## Creating and using projects |
There was a problem hiding this comment.
Aha, so there are tasks here after all, so maybe "Projects" is the right title for the page.
You could call this section "Work with projects", then you could have Create, View, Manage, Delete. Or you could have a section Projects with "Overview" and "Work with projects" or something like that. I'd prefer the non-gerund forms.
| Access your projects in the Weave UI: | ||
|
|
||
| 1. Navigate to [wandb.ai](https://wandb.ai) | ||
| 2. Select your project from the **Projects** sidebar. This opens the project's overview page. |
There was a problem hiding this comment.
You could send them straight here in step 1.
There was a problem hiding this comment.
I like step 1, imo. But for step 2:
2. From the sidebar menu, click Project. This opens the project’s overview page.
I 'think' this 'might' be what we are standardizing towards ;) based on the slack conversation. in other places now I'd say 'weave sidebar'...but in this case it doesn't matter since project appears in both.
i also think maybe we should add maybe a Note somewhere like:
The W&B sidebar menu changes depending on the activity within your project. Your sidebar displays different options if you are doing Models work or Weave work in your project. A fresh project displays both, but might later change to display one or the other depending on your project’s usage.
There was a problem hiding this comment.
Super minor, but the browser could be a bit narrower for this screenshot to improve the information density.
Co-authored-by: Matt Linville <matt.linville@wandb.com>
4 participants
Description
Resolves DOCS-1478 and DOCS-1731. This adds a Weave projects overview page documenting how projects are structured and what they contain.