user_guide icon indicating copy to clipboard operation
user_guide copied to clipboard

Possible wrong ordering of sections in the Topics

Open zoe-translates opened this issue 1 year ago • 2 comments

https://github.com/common-workflow-language/user_guide/blob/dbeb91c9aa4e0343cc129f9986f9482986efe6a3/src/topics/parameter-references.md?plain=1#L3

Here the "previous example" seems to be a reference to src/topics/outputs.md. But in the current ordering of sections, parameter-refernece.md is Section 2.6 which comes before outputs.md at 2.7.

It seems their ordering should be reversed.

zoe-translates avatar Jun 28 '23 14:06 zoe-translates

How about "in the outputs example" with a link?

mr-c avatar Jun 29 '23 02:06 mr-c

Hi! I think the content of this section ("Parameter References") does build upon the "tar" example in "Outputs". For users going through the Topics in-order, the ordering would be meaningful, I think.

But if this is done by exchanging the order of these sections in topics/index.md, will that cause unintended complications, such as lost message translations in Weblate?

zoe-translates avatar Jul 03 '23 03:07 zoe-translates