diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b2b697f..5ce588e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -22,9 +22,9 @@ Drive-by claims without sources will get held until they can be verified. ## Checklist -- [ ] I read [`CONTRIBUTING.md`](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/blob/main/CONTRIBUTING.md) +- [ ] I read [`CONTRIBUTING.md`](https://github.com/wesammustafa/opencode-primer/blob/main/CONTRIBUTING.md) - [ ] Every factual claim cites a source (in the PR or inline in the doc) - [ ] In-page anchors and cross-doc links still resolve - [ ] No trailing whitespace; code fences have language tags -- [ ] Emoji follow the [`AGENTS.md` policy](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/blob/main/AGENTS.md#style-conventions) (H2 navigation + callout prefixes only) +- [ ] Emoji follow the [`AGENTS.md` policy](https://github.com/wesammustafa/opencode-primer/blob/main/AGENTS.md#style-conventions) (H2 navigation + callout prefixes only) - [ ] If I touched the README, I updated the "Last reviewed" line at the bottom diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2a19b71..3630afc 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -30,7 +30,7 @@ This Code of Conduct applies within all project spaces — issues, pull requests ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the maintainers by contacting the repository owner directly via their GitHub profile. (For security issues specifically, use [GitHub's private vulnerability reporting](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/security/advisories/new) instead — see [`SECURITY.md`](SECURITY.md).) All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the maintainers by contacting the repository owner directly via their GitHub profile. (For security issues specifically, use [GitHub's private vulnerability reporting](https://github.com/wesammustafa/opencode-primer/security/advisories/new) instead — see [`SECURITY.md`](SECURITY.md).) All complaints will be reviewed and investigated promptly and fairly. Maintainers are obligated to respect the privacy and security of the reporter of any incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3629021..3941aa4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,7 @@ npx markdown-link-check -c .github/markdown-link-check.json README.md ## Questions -Open a [GitHub Discussion](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/discussions) or an [issue](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/issues). Drive-by PRs are welcome too — we'll suggest changes in review. +Open a [GitHub Discussion](https://github.com/wesammustafa/opencode-primer/discussions) or an [issue](https://github.com/wesammustafa/opencode-primer/issues). Drive-by PRs are welcome too — we'll suggest changes in review. --- diff --git a/Images/banner.svg b/Images/banner.svg index 18c31fd..f5cd4ef 100644 --- a/Images/banner.svg +++ b/Images/banner.svg @@ -1,4 +1,4 @@ - + @@ -25,7 +25,7 @@ - THE COMMUNITY FIELD GUIDE + THE COMMUNITY PRIMER OpenCode Everything You Need to Know diff --git a/Images/social-preview.png b/Images/social-preview.png index fbbd4ff..3afba18 100644 Binary files a/Images/social-preview.png and b/Images/social-preview.png differ diff --git a/README.md b/README.md index a9bd270..1c87628 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -OpenCode: Everything You Need to Know — the community field guide to the open-source AI coding agent +OpenCode Primer — everything you need to know about the open-source AI coding agent -# OpenCode: Everything You Need to Know +# OpenCode Primer -The community field guide to [OpenCode](https://opencode.ai) — from your first prompt to custom agents, skills, plugins, and MCP integrations. Clear mental models, real examples, every fact verified against the current release. +Everything you need to know about [OpenCode](https://opencode.ai) — from your first prompt to custom agents, skills, plugins, and MCP integrations. Clear mental models, real examples, every fact verified against the current release. [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE) [![OpenCode v1.17.13](https://img.shields.io/badge/OpenCode-v1.17.13-7C3AED?style=flat-square)](https://github.com/anomalyco/opencode/releases) [![Last reviewed](https://img.shields.io/badge/last%20reviewed-July%202026-22c55e?style=flat-square)](#updates--deprecations) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4?style=flat-square)](CONTRIBUTING.md) -[![GitHub stars](https://img.shields.io/github/stars/wesammustafa/OpenCode-Everything-You-Need-to-Know?style=flat-square&color=eab308)](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/stargazers) +[![GitHub stars](https://img.shields.io/github/stars/wesammustafa/opencode-primer?style=flat-square&color=eab308)](https://github.com/wesammustafa/opencode-primer/stargazers) ```bash curl -fsSL https://opencode.ai/install | bash @@ -727,6 +727,6 @@ Set `bash` permission to `"ask"` at the project level, or use the glob form to w > Features, pricing, and availability change frequently. Always check the [official OpenCode documentation](https://opencode.ai/docs/) for the most current information. -*Last reviewed 2026-07-05 · OpenCode v1.17.13 · Spotted something stale? [Open an issue](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/issues) or send a PR — see [`CONTRIBUTING.md`](CONTRIBUTING.md).* +*Last reviewed 2026-07-05 · OpenCode v1.17.13 · Spotted something stale? [Open an issue](https://github.com/wesammustafa/opencode-primer/issues) or send a PR — see [`CONTRIBUTING.md`](CONTRIBUTING.md).* -**Found this useful? [Give it a ⭐](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know) — it's how other developers discover the guide.** +**Found this useful? [Give it a ⭐](https://github.com/wesammustafa/opencode-primer) — it's how other developers discover the guide.** diff --git a/SECURITY.md b/SECURITY.md index 475799d..8f213de 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -17,7 +17,7 @@ If you find a security issue in: | Where | Report to | |---|---| | **OpenCode itself** (the tool) | Open a [security advisory on `anomalyco/opencode`](https://github.com/anomalyco/opencode/security/advisories/new) | -| **The example plugins in this repo** | Use GitHub's [private vulnerability reporting](https://github.com/wesammustafa/OpenCode-Everything-You-Need-to-Know/security/advisories/new) ("Report a vulnerability" under the repo's Security tab) | +| **The example plugins in this repo** | Use GitHub's [private vulnerability reporting](https://github.com/wesammustafa/opencode-primer/security/advisories/new) ("Report a vulnerability" under the repo's Security tab) | | **A factual error in documentation** that could mislead a user into a vulnerable configuration | Open a normal issue or PR | Please **don't** disclose security issues publicly until they've been addressed. We'll acknowledge receipt within 7 days and aim to resolve within 30.