Skip to content

docs: brand the README hero and add community health files - #249

Merged
Theosakamg merged 3 commits into
getgaal:mainfrom
gregqualls:docs/readme-hero-and-community-files
Jul 8, 2026
Merged

docs: brand the README hero and add community health files#249
Theosakamg merged 3 commits into
getgaal:mainfrom
gregqualls:docs/readme-hero-and-community-files

Conversation

@gregqualls

Copy link
Copy Markdown
Contributor

Summary

Redesigns the README top section with a branded hero and adds the missing community health files. No Go code changes.

  • New README hero: logo banner on pure black, subtitle, full-width demo GIF, Website / Docs / Quick start / Report a bug links, badges, and a five-capability Features list (repositories, skills, content, MCP servers, sync commands). The YAML example now matches the website homepage.
  • Adds CONTRIBUTING.md (tailored to the make targets and AGENTS.md conventions), CODE_OF_CONDUCT.md (Contributor Covenant 2.1), and SECURITY.md (GitHub private reporting plus hello@getgaal.com).
  • Adds a Contributing section to the README linking the three files.
  • Enables blank issues and removes the Discussions contact link, since Discussions is not enabled yet, so questions can be filed as issues.

New assets: docs/assets/gaal-banner.png and docs/assets/gaal-demo.gif (optimized, 4.3 MB).

Type of Change

  • Bug fix
  • New feature
  • Refactor (no functional change)
  • Documentation
  • Chore / dependency update

Related Issues

None.

Checklist

Docs and repo-meta only; no Go files changed, so the lint / build / test gates are unaffected by this PR.

  • make lint passes (no Go files changed)
  • make build passes on Linux and macOS (no Go files changed)
  • make test-ci passes (no Go files changed)
  • make coverage-ci run (not applicable, no covered code changed)
  • Every new function has a slog.Debug call (not applicable, no new functions)
  • Documentation updated
  • No secrets or credentials are exposed

Follow-ups for maintainers

  • Enable GitHub private vulnerability reporting (Settings > Security) so the SECURITY.md link works.
  • Make sure hello@getgaal.com is monitored (it is the Code of Conduct and security contact).

🤖 Generated with Claude Code

gregqualls and others added 3 commits July 3, 2026 11:56
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Theosakamg
Theosakamg merged commit 82cd0c9 into getgaal:main Jul 8, 2026
12 checks passed
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.

2 participants