Skip to content

Split repository guidance into directory READMEs - #68

Merged
akriaueno merged 1 commit into
developfrom
docs/split-readmes
Sep 3, 2026
Merged

akriaueno merged 1 commit into
developfrom
docs/split-readmes

Conversation

@akriaueno

@akriaueno akriaueno commented Sep 3, 2026

Copy link
Copy Markdown
Member

Summary

  • keep the root README focused on the repository overview and directory layout
  • add templates/README.md for the template catalog and usage instructions
  • keep example-specific information in examples/README.md
  • simplify the directory README titles to Templates and Examples

Validation

  • verified every relative link in the three affected README files
  • confirmed all 11 templates and both examples are linked from their respective directories
  • ran git diff --check

Note

The SonarCloud workflow fails before analysis because its token cannot query JRE metadata. This is the same existing authentication failure seen on develop and is unrelated to this documentation-only change.

Keep the root overview concise and move template-specific listings and usage instructions into templates/README.md.
@akriaueno
akriaueno merged commit 4275d51 into develop Sep 3, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant