spring-projects / spring-projects/spring-security

Automate Generation of docs direcotry of samples

Open
#8,328 1 comment 0 reactions 0 assignees View on GitHub

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

Add automation that can generate a list of samples and insert it into the documentation automatically. see Issue spring-projects/spring-security#8190 and spring-projects/spring-security-samples#62

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

Read spring-projects/spring-security#8190 and spring-projects/spring-security-samples#62 first to understand the requested sample-list generation and documentation insertion. Identify the repository's documentation and automation entry points, then define completion as a repeatable process that generates the samples list and updates the documentation without manual editing.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
build-system, documentation
Issue type
Feature
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.