Skip to content

Conversation

@eshanrnh
Copy link
Contributor

@eshanrnh eshanrnh commented Mar 28, 2025

Description

Fixes #6904

Type of suggestion

  • Typo/grammar fix
  • Updated outdated content
  • New content
  • Updates related to a new version
  • Other

Product & version (if relevant)

Commverce v15

Deadline (if relevant)

Anytime

@eshanrnh eshanrnh requested a review from mattbrailsford March 28, 2025 10:07
Copy link
Contributor

@mattbrailsford mattbrailsford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content is good, but I would have said this was more of a how-to-guide than an explanation of the Order Number Generation feature. As such, I'd probably move it to the "How to Guides" section.

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding file names to the code sample would be a big help here 💪

Does it make sense to add steps? Like, in ordered lists? Doesn't sound like there's a lot of steps, so not sure it's relevant.

@eshanrnh
Copy link
Contributor Author

Thanks for the review 🙌

@mattbrailsford I've moved the file to the "How to Guides" section.
@sofietoft I've added the file name. Since it's just a single step, I haven’t included numbers (ordered list) for the step.

@mattbrailsford
Copy link
Contributor

mattbrailsford commented Mar 28, 2025

I think @sofietoft meant with regards to filenames to add the following tags around code blocks

{% code title="CurerrencySwitcher.cshtml" %}

<!-- CODE BLOCK HERE-->

{% endcode %}

It then adds a nice looking label to the codeblocks

image

@sofietoft
Copy link
Contributor

Ah, yes! Matt is right. That is what I meant 💪

I think we should add this whenever possible!

@eshanrnh
Copy link
Contributor Author

eshanrnh commented Mar 28, 2025

Ah, Got it! The file name is now added as a label to the code block 🙌

@eshanrnh
Copy link
Contributor Author

@mattbrailsford The code block was rendering correctly in Preview mode without the line breaks around it. However, I have now added them based on your suggestion 🙌 I didn't include a code tag for the file name since the rest of the article uses backticks to highlight filenames and methods 🤞

@mattbrailsford
Copy link
Contributor

@eshanrnh ahhh, excellent. I wasn't sure if the line returns were required or not, but I just knew sometimes they are needed when mixing markdown with other tag types so thought it was best to air on the side of caution.

RE not adding the code tag, I think I still would as that seems to be what we have done in other areas of the docs so even if the sentence leading up to the code block mentions the file name, I think it's still a good idea to add the {% code %} block around to show the filename of the code example.

@mattbrailsford
Copy link
Contributor

LGTM Nice work 👍

@eshanrnh
Copy link
Contributor Author

I think the PR should be good to merge now 😀

@eshanrnh eshanrnh merged commit b252f3e into main Mar 31, 2025
29 of 37 checks passed
@eshanrnh eshanrnh deleted the dxp-integrations branch March 31, 2025 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for replacing the Umbraco Commerce order number generator

4 participants