spring-projects / spring-projects/spring-boot

Provide aggregated documentation for offline use

Open
#40,894 19 comments 30 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: task
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

Hi,

Seems that with Spring Boot 3.3.0 you have removed the single page variant of the reference documentation, as it now redirects to https://docs.spring.io/spring-boot/index.html. Please restore it, it's necessary for

  1. fast cross referencing across the entire framework and
  2. finding things which one can't remember exact names/keywords for

The segmented reference at https://docs.spring.io/spring-boot/index.html is useful only if one already knows the general structure of the whole documentation, which really doesn't apply to a casual reader since Boot is a massive project.

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

Start by reviewing the segmented reference documentation at https://docs.spring.io/spring-boot/index.html and the redirect behavior described in the issue. Determine how the former single-page reference was generated or published, then verify that the complete Spring Boot reference can be accessed as one document for offline searching and cross-referencing.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.