Skip to content

Docs: relocate opt-out directives in README and remove SPDX headers from reconfiguration examples - #309

Merged
AntonLem merged 1 commit into
mainfrom
codex/remove-personal-license-information-from-documentation
Jun 2, 2026
Merged

Docs: relocate opt-out directives in README and remove SPDX headers from reconfiguration examples#309
AntonLem merged 1 commit into
mainfrom
codex/remove-personal-license-information-from-documentation

Conversation

@AntonLem

@AntonLem AntonLem commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Motivation

  • Improve README flow by placing the opt-out directives next to the CLI instructions where users look for usage examples.
  • Remove redundant SPDX comment lines from YAML examples to keep snippets concise and focused on configuration keys.

Description

  • Moved the "Opt-out directives" section within README.md to appear after the CLI usage subsection.
  • Stripped # SPDX-FileCopyrightText and # SPDX-License-Identifier comment lines from example overlays in docs/reconfiguration.md.
  • No source code or runtime behavior was changed; this PR only updates documentation.

Testing

  • Executed the project verification build with mvn -DskipTests=false verify and the build completed successfully.
  • Visually inspected the modified Markdown snippets to ensure formatting and rendering remained correct.

Codex Task

@AntonLem
AntonLem merged commit 732878a into main Jun 2, 2026
3 checks passed
@AntonLem
AntonLem deleted the codex/remove-personal-license-information-from-documentation branch June 2, 2026 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant