Skip to content

Document installation and usage examples#42

Merged
Will-thom merged 1 commit into
mainfrom
docs/install-usage-examples
May 26, 2026
Merged

Document installation and usage examples#42
Will-thom merged 1 commit into
mainfrom
docs/install-usage-examples

Conversation

@Will-thom
Copy link
Copy Markdown
Collaborator

Summary

  • Add dedicated installation and usage guides.
  • Add runnable CLI, library, and GitHub Actions examples.
  • Add documentation coverage test so key install and usage links stay present.

Validation

  • go test ./... with repository-local GOCACHE
  • go run ./examples/library demo/multi-module-failure

@github-actions
Copy link
Copy Markdown

Hi @Will-thom, thank you for contributing to PR Maven CLI.

I appreciate the time you spent opening this pull request. This project is intentionally shaped for focused, reviewable open source contributions, so your input helps the tool become more useful for Java and Maven teams.

A maintainer will review the context, labels, and next steps as soon as possible. If this is your first contribution here, welcome aboard.

Useful links:

  • Contributing guide: CONTRIBUTING.md
  • Testing guide: docs/testing.md
  • CI/CD guide: docs/ci.md

Thank you for helping build a deterministic, local-first Maven failure triage tool.

@Will-thom Will-thom merged commit 8ecbae3 into main May 26, 2026
21 checks passed
@Will-thom Will-thom deleted the docs/install-usage-examples branch May 26, 2026 21:29
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