Documentation | Software Engineering Guide has broken Reference (#125)

Joel Sherrill (@joel) gitlab at rtems.org
Wed Jan 7 04:26:22 UTC 2026



Joel Sherrill created an issue: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/125

Assignee: Chris Johns

Section 3, RTEMS Stakeholders, has a single paragraph which renders like this in the html at https://docs.rtems.org/branches/master/eng/stakeholders.html:


```
Please have a look at the Support and Contributing chapter of the ERROR: :r:url:`user`.
```

A bit of investigation shows that it is trying to link to https://docs.rtems.org/branches/master/user/support/index.html. That section appears to be there correctly. 

Looking for documentation for the ":r:url:" syntax, I could not find any on the net. I see 48 uses of ":r:". I suspect but did not check that they all might be broken. What is ":r:" and what makes it work?

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/125
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260107/b660dc0b/attachment.htm>


More information about the bugs mailing list