openSUSE / suse-vale-styleguide

Humble style guide for technical writers by a technical writer
GNU General Public License v3.0
23 stars 5 forks source link

Links #117

Closed alexvonme closed 3 months ago

alexvonme commented 4 months ago

I've added links to denote sources for rules, in accordance with SUSE requirements on how to link to SUSE documentation. By which I mean, links were added that refer to:

The changes will hopefully help to maintain and improve the style guide.

Many rules had a directly identifiable source from the Language section.

Meanwhile, I linked the following rules to "Writing for a Global Audience", since they seemed most in-line with SUSE principle there, "Simplicity, clarity and direct prose are essential", rather than any specific rule in the Language section.

Lastly, I couldn't add the links to these rules since they don't seem to be explicitly stated in the SUSE style guide: