Created guide for organizing the model inventory#210
Created guide for organizing the model inventory#210noosheenv merged 24 commits intomainvalidmind/documentation:mainfrom noosheenvazinkhoo/sc-3668/model-inventory-findings-manage-columnsvalidmind/documentation:noosheenvazinkhoo/sc-3668/model-inventory-findings-manage-columnsCopy head branch name to clipboard
Conversation
nrichers
left a comment
There was a problem hiding this comment.
Nice! Great to see more docs topics from you, @noosheenv. 🏅 I left some comments to address — please ask me to re-review when ready?
Co-authored-by: Nik Richers <nik@validmind.ai>
…ge-columns' of https://github.com/validmind/documentation into noosheenvazinkhoo/sc-3668/model-inventory-findings-manage-columns
validbeck
left a comment
There was a problem hiding this comment.
Left some suggestions, I would also recommend you try commiting the online suggestions and then pulling down those changes locally before working on more edits.
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
|
I made the "Working with the model inventory" as @validbeck suggested. I added gifs because I thought it would look cool but now it's so busy. But also I got attached to the gifs so it's hard to let go. ALSO I'm struggling so hard with the little description at the top. ALSO ALSO should I put the prerequisites back? |
validbeck
left a comment
There was a problem hiding this comment.
Forgive me if you're still working on stuff, as you got some stuff and missed others!
- Are there prerequisites? Are there certain roles you need to work with these features? ;) (Maybe ask in
#engineering?) - Put
Register models in the inventory&Edit model inventory fieldsUNDER "Working with the model inventory," like how it looks in the other menus:
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
|
Made edits mentioned in yesterday's catchup:
|
validbeck
left a comment
There was a problem hiding this comment.
Working with the model inventory
- Nice job wrapping the sub-articles under this landing page! 🎉
- The intro is a bit better, but it still needs some more pep. I've noticed that sometimes your descriptions are a bit fluffy, and that's very common! The only way to get good at writing is just to keep doing it, make many mistakes so you can learn, and practicing more until we get better :) When we describe things, we want to bring value to the user, i.e. what benefit does the feature offer users on top of a summary of the basic functionality?
See
Working with documentation templatesfor some inspiration and an example of what I'm talking about. For this I'd recommend doing some reading as to why model inventories are important to MRM.
- You're missing some important info about how sorting and customization works – see if you can figure it out when you re-read the Shortcut Story (you are reading the comments/discussion on a Story before you start working, right? ;)). I'd recommend a call-out box for this.
- As this is a landing page, let's change the "What's next" section back to the CTA cards (sorry!)
Register models in the inventory
- For the
If the model is a vendor model, toggle Is Vendor Model and provide the vendor name.line, I'd just remove the link within the sentence here and put a callout box with a link under this step something to the effect of "Learn more about vendor models."
Customize model inventory layout
You probably want a callout box here as well under the intro for that important detail when you find it ;)
- For "Steps," I would just wrap
Manage columnsinto the step-by-step and remove the subheader for this section. You may want to make sure that your step has a note that you need to be inDisplay tableview. - Make sure your screenshots have appropriate white-space before and after, as the gifs on this page are bumping right up against the text.
- For "Toggle card and table view" I would just remove the gif and section and make this a callout, something along the lines of:
To display the inventory in list view, click ** Display table**. To display the inventory in card view, click **Display cards**.Remember: we're looking to simplify, not overcomplicate.
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
validbeck
left a comment
There was a problem hiding this comment.
As much as I'd like to keep #validpride... otherwise, looks great! I think I do like the callout at the top of the "Customize" page, it's further away enough from the other one that it shouldn't be a problem.
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
validbeck
left a comment
There was a problem hiding this comment.
Just one last tweak — you can use the Commit suggestion button then go ahead and merge into main!! 🎉
Internal Notes for Reviewers
I created a guide for organizing the model inventory, like using the filter and manage columns feature. The little text in the beginning and the prerequisites feel a bit abrupt, so some advice would be appreciated!
Sneak peek:


External Release Notes