spring-projects / spring-projects/spring-security
Polish the title of the javadoc
Open
Nobody has claimed this yet.
in: docs
type: enhancement
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
In 5.5.3 the javadoc's title is "spring-security-docs-manual 5.5.3 API". In 5.6.0-RC1 it is "spring-security-docs 5.6.0-RC1 API". For consistency with other projects, I think it'd be better if it was "Spring Security […] API" in each case.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Javadoc generation or documentation configuration that produces the current API title for Spring Security. Compare the 5.5.3 and 5.6.0-RC1 title formats, then verify that generated titles consistently use the requested “Spring Security […] API” wording across versions.
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