chore: improve discoverability and marketing readiness#27
chore: improve discoverability and marketing readiness#27mikkeldamsgaard merged 1 commit intomainfrom
Conversation
- Add crates.io metadata to Cargo.toml (repository, homepage, docs, keywords, categories) - Add Features section and Alternatives comparison table to README - Create CONTRIBUTING.md with build, test, and PR guidelines - Add Artifact Hub repo config for Helm chart discovery - GitHub topics and homepage URL set via gh CLI Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request prepares the Initium project for publication to crates.io and improves its discoverability through enhanced documentation and metadata. The changes are focused on marketing, documentation, and repository metadata without any code modifications.
Changes:
- Added crates.io metadata fields to
Cargo.tomlfor package publication - Enhanced
README.mdwith a Features section and Alternatives comparison table - Created
CONTRIBUTING.mdwith comprehensive build, test, and contribution guidelines - Added Artifact Hub repository metadata for Helm chart discoverability
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
Cargo.toml |
Added crates.io metadata (repository, homepage, documentation URLs, keywords, categories, readme) |
README.md |
Added Features bullet list and Alternatives comparison table for better discoverability |
CONTRIBUTING.md |
New file with prerequisites, build/test commands, coding guidelines, and contribution workflow |
charts/initium/artifacthub-repo.yml |
Added Artifact Hub repository metadata for Helm chart registration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 5. Add unit tests in the same file | ||
| 6. Add integration tests in `tests/integration_test.rs` | ||
| 7. Document in `docs/usage.md` and `README.md` | ||
| 8. Update `Changelog.md` under `[Unreleased]` |
There was a problem hiding this comment.
The filename is inconsistent with the actual file. The file is named "CHANGELOG.md" (all uppercase), but this references "Changelog.md" (mixed case). Update this to "CHANGELOG.md" to match the actual filename.
| 8. Update `Changelog.md` under `[Unreleased]` | |
| 8. Update `CHANGELOG.md` under `[Unreleased]` |
| repository = "https://github.com/KitStream/initium" | ||
| homepage = "https://github.com/KitStream/initium" | ||
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" |
There was a problem hiding this comment.
The GitHub organization name should be lowercase "kitstream" to match the rest of the codebase. The existing README, release workflow, and all other references consistently use "kitstream" (all lowercase), not "KitStream" (mixed case). While GitHub URLs are case-insensitive, it's best to use the canonical form consistently throughout the project. Update this to "https://github.com/kitstream/initium".
| repository = "https://github.com/KitStream/initium" | |
| homepage = "https://github.com/KitStream/initium" | |
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" | |
| repository = "https://github.com/kitstream/initium" | |
| homepage = "https://github.com/kitstream/initium" | |
| documentation = "https://github.com/kitstream/initium/blob/main/docs/usage.md" |
| repository = "https://github.com/KitStream/initium" | ||
| homepage = "https://github.com/KitStream/initium" | ||
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" |
There was a problem hiding this comment.
The GitHub organization name should be lowercase "kitstream" to match the rest of the codebase. The existing README, release workflow, and all other references consistently use "kitstream" (all lowercase), not "KitStream" (mixed case). While GitHub URLs are case-insensitive, it's best to use the canonical form consistently throughout the project. Update this to "https://github.com/kitstream/initium".
| repository = "https://github.com/KitStream/initium" | |
| homepage = "https://github.com/KitStream/initium" | |
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" | |
| repository = "https://github.com/kitstream/initium" | |
| homepage = "https://github.com/kitstream/initium" | |
| documentation = "https://github.com/kitstream/initium/blob/main/docs/usage.md" |
| repository = "https://github.com/KitStream/initium" | ||
| homepage = "https://github.com/KitStream/initium" | ||
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" |
There was a problem hiding this comment.
The GitHub organization name should be lowercase "kitstream" to match the rest of the codebase. The existing README, release workflow, and all other references consistently use "kitstream" (all lowercase), not "KitStream" (mixed case). While GitHub URLs are case-insensitive, it's best to use the canonical form consistently throughout the project. Update this to "https://github.com/kitstream/initium/blob/main/docs/usage.md".
| repository = "https://github.com/KitStream/initium" | |
| homepage = "https://github.com/KitStream/initium" | |
| documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md" | |
| repository = "https://github.com/kitstream/initium" | |
| homepage = "https://github.com/kitstream/initium" | |
| documentation = "https://github.com/kitstream/initium/blob/main/docs/usage.md" |
Summary
Cargo.toml(repository, homepage, documentation, keywords, categories) — prepares forcargo publishREADME.mdfor SEO and AI-assistant discoverabilityCONTRIBUTING.mdwith build, test, and PR guidelinescharts/initium/artifacthub-repo.ymlfor Helm chart Artifact Hub registrationGitHub topics (10) and homepage URL were set directly via
gh repo edit(already live).Test plan
cargo checkpasses with new Cargo.toml metadata🤖 Generated with Claude Code