spring-projects / spring-projects/spring-boot

Review and split up large documentation pages

Open
#40,064 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: team-only type: documentation
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

We didn't apply automatic splitting of pages during the Antora migration so we should manually review any large pages. This should be done after #40063

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by checking issue #40063, since this work is explicitly dependent on it. After the Antora migration work is complete, identify the large documentation pages that still need review and manually split the pages where appropriate; completion means the relevant large pages have been reviewed and oversized content is divided.

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
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.