Fix API documentation broken links in the doc-site
ericnordelo opened this issue · 0 comments
ericnordelo commented
There are a few places where the autogenerated link is either broken or miss-formatted:
I noticed three main cases:
- The scoped module is missing (ex:
{renounceRole}
instead of{AccessControl-renounceRole}
). - Extra pair of brackets (ex:
{{renounceRole}}
instead of{renounceRole}
) - References to private functions that are not automatically documented, becoming broken references in the doc-site (ex:
{_getAdminRestrictions}
in AccessManager).
The first two should be directly fixed, or a rule can be created to check them (asciidoctor detects the broken references for ex).
For the latter, I think a design to avoid private function references in the doc-site would be helpful (something as simple as using privateFunctionName
instead of {privateFunctionName} could help.
EDIT: Here is a link to some broken references in the doc-site (third paragraph).