jakartaee / jakartaee/persistence

Need to fix invalid cross-references in the specification

Open
#525 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
267
Forks
78
Avg merge
1d 6h
Merged PRs (30d)
13

Description

In reviewing the current specification and its source, there are several `<>` type of references that seem to be from the old framemaker version of the spec that have not been properly ported or defined. I'll create a PR for some of the ones I ran into, but we should have a list of the invalid cross references and fix them. I'll look to see if there is a way to capture the unresolved cross references from the asciidoc plugin.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current specification and its source, then investigate whether the Asciidoc plugin can capture unresolved cross-references. The work is done when the invalid references are listed and the affected references are corrected or properly defined.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.