documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[IMP] Merged cycle counts docs and updated for 17.0

Open kekiss opened this issue 1 year ago • 1 comments

kekiss avatar Aug 09 '24 19:08 kekiss

Pull request status dashboard

robodoo avatar Aug 09 '24 19:08 robodoo

Thank you so much for your quick turnaround on this task after it was assigned, @benderliz! I really appreciate your hard work replacing the images and icons and your attention to detail in aligning everything with our updated standards. You’ve maintained your usual high quality while working swiftly—great job! 😄

I had some very small suggestions, and after you consider those, this PR is ready for the next stage.

Also, can you help Kara fix something she forgot to do? 😊

  • Rename this PR to [IMP] inventory: {concise summary of changes}
  • While PR descriptions are optional, it's good practice to have a bullet point summary of the changes
  • In the PR description, include a link to the task and mention if the changes are meant to be forward-ported. (In our case, yes 🎊)

Since I’m the peer reviewer for this PR, I’d like it to go through the final review stage as well. Once you’ve pushed your updates to the feature branch (great job btw, I had only nitpicks in this round!), please tag us-doc-review to move it forward. Given the upcoming deadline, I’ll monitor this PR to ensure @StraubCreative reviews it before our vacation next Tuesday. I don’t foresee any issues with getting this published on time.

Thank you again for your responsiveness and excellent work! 🙌

@Felicious, thank you so much for the attentive feedback (both for Kara and myself - that made everything much easier!) 🏆

I have re-committed with your suggested changes, so I think this PR is ready for @StraubCreative 's review! 😸

benderliz avatar Dec 30 '24 17:12 benderliz

Hi @benderliz

I think we're almost there with this PR! See below for a handful of suggestions, some are optional or for you to consider later on another PR.

The main items to address I think are:

  • the list items at the beginning, as they relate to the additional options menu (what is optional vs. what is not), along with the formatting of the list items (they're not rendering correctly in the html)
  • some line breaks here and there (trying to set you up for success with Sam)
  • adding more legible screenshots (can do now or later)

Before you push your changes back up you can run make review in your terminal and it will tell you of line break issues. To catch html rendering issues, you can do make fast to view the doc in your local browser.

Hope this helps, please let me know if you have any questions or need a hand!

cc: @Felicious

Hi @StraubCreative - thanks for the extra detailed review! I have implemented most of your suggestions. The rest (adding new screenshots and re-writing the 'Count Products' section) I will add in a new PR.

Should I pass this along to Sam?

Thank you and @Felicious for the thorough reviews!

benderliz avatar Jan 02 '25 19:01 benderliz

Should I pass this along to Sam?

Thank you and @Felicious for the thorough reviews!

Great @benderliz, I'd like to take another quick look at the revisions once the build error(s) are addressed. We'll want the CI check to pass ✅ before going to Sam.

Looks like there's a small formatting issue around line 160— can you take a look?

StraubCreative avatar Jan 02 '25 20:01 StraubCreative

@StraubCreative I think things should be all good to go! I committed a little while ago to make the small fix (it was an extra indent in the newly-added 'Tip' block), but I realized afterward that there were 4 hidden conversations I needed to address from your OG review. So, now I think things should be good to move to Sam! :)

benderliz avatar Jan 02 '25 22:01 benderliz

@benderliz reference earlier review for those outstanding items, ty!

StraubCreative avatar Jan 03 '25 03:01 StraubCreative

Hi @samueljlieber! I believe this doc is ready for a technical review. There are some changes I need to make in a follow-up PR (like taking new screenshots and updating the section about cycling counting), but for now, this is just to make some quick changes that Kara had implemented.

benderliz avatar Jan 07 '25 18:01 benderliz

@robodoo r+

benderliz avatar Jan 10 '25 21:01 benderliz