search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

Module re-use section incorrectly directs use of hyphen for appending {context} #115

Closed cbudz closed 3 years ago

cbudz commented 4 years ago

https://redhat-documentation.github.io/modular-docs/#reusing-modules

" add the {context} suffix with a hyphen to the anchor name in the format "

When implemented {context} is appended to the anchor name using an underscore.

sterobin commented 4 years ago

@cbudz , right. That's supposed to say to use an underscore. That's how I had originally written that section and lately had re-suggested that. That has been changed and re-changed times over. Should be hyphenated all around, except before context: proc-doing-something_{context}. The prefix is also under consideration by @adahms, as you know. Hopefully this is circling to a conclusive decision.

cbudz commented 4 years ago

@sterobin thanks for the response on this. I'll keep an eye out for updates.

emmurphy1 commented 3 years ago

This issue was resolved in https://github.com/redhat-documentation/modular-docs/pull/121 and the changes incorporated in the Reference Manual.