Skip to content

ThunderXBlitZ/MySpringBootDex

Repository files navigation

SpringBootDex

A modern glossary for Spring Boot / Spring annotations.

Daunted by the official Spring/Spring Boot documentation? No doubt they are extensive and the best source of documentation, yet like many others, I found the learning curve still steep due to Spring/Spring Boot's rich history.

Hence the idea to create a (not literally) ELI5 guide/glossary, that serves as as a training guide for newbies, as well as a quick lookup for professionals. Feel free to make suggestions and contribute!


Features

  1. Search Engine (courtesy of Just-The-Docs)
  2. Tooltips
  3. Category Tags
  4. Dark mode

Contribution Rules

  1. Keep it simple! Keep the languange concise and non-technical where possible.
  2. Add internal/external links where possible e.g. @SpringBootApplication links to @Configuration. Internal links enable the tooltip feature (which I hope people find handy)
  3. References to external guides are encouraged, with a short write up, but do give credit where its due.

Acknowledgements

  1. Just-The-Docs Jekyll template, a beautiful, minimalistic Jekyll template that provided the key features I needed.