Skip to content

Remove duplicate badge line and stale FAQ stub from docs - #124

Merged
slachiewicz merged 1 commit into
masterfrom
agent/sweep-interactivity-docs
Nov 18, 2026
Merged

slachiewicz merged 1 commit into
masterfrom
agent/sweep-interactivity-docs

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Why

Two pieces of leftover documentation cruft: the README repeats the
"Check the badge above for the current version." line below the usage
example (it already appears above the dependency snippet), and the API
module's site menu still carries a commented-out FAQ item pointing to a
non-existent faq.html.

Area

Documentation — README.md, plexus-interactivity-api/src/site/site.xml. No production code.

Changes

  • Removed the second "Check the badge above for the current version."
    line from README.md.
  • Removed the commented-out FAQ menu item from
    plexus-interactivity-api/src/site/site.xml.

Verification

  • JAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-21.jdk/Contents/Home mvn -B -o spotless:apply — BUILD SUCCESS (0 files changed)
  • mvn -B -o spotless:check — BUILD SUCCESS
  • mvn -B -o test — BUILD SUCCESS; Tests run: 4, Failures: 0, Errors: 0, Skipped: 0

The README's second 'Check the badge above' line duplicated the one above the dependency snippet, and the API module's site menu kept a commented-out FAQ item pointing to a non-existent faq.html. Both are leftover cruft.
@slachiewicz slachiewicz added the documentation Improvements or additions to documentation label Nov 18, 2026
@slachiewicz
slachiewicz merged commit 4d4642d into master Nov 18, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant