jakartaee / jakartaee/authentication
Spec. Doc Review: Incorrect internal-doc links in final Spec document
- Dominant language
- Java
- Stars
- 27
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
There are a few links that weren't updated properly in the spec. These appear to have the form: "link:jaspic.html#aXXX". These should be converted to the form <> or more generally <>
One example is near the end of section 1.1.10: "See what the Runtime Must Do". This should be changed per the pattern previous. I think there were others.
Some references in the change log don't have any reference text. This reads poorly.
It is unfortunate that changes section wasn't updated for this revision. Perhaps next time the document is revised, this could be included.
Contributor guide
Research direction
Locate the final Spec document and search for occurrences of `link:jaspic.html#aXXX`, starting with the example near section 1.1.10. Convert the internal links consistently and add missing reference text in the change log; done means no malformed matching links or textless references remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100