docs: strengthen docs system and release guidance#6
Conversation
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
There was a problem hiding this comment.
Pull request overview
This PR strengthens the documentation system for the opencode-ceo project by expanding bilingual (English and Turkish) coverage, adding explicit release and governance guides, and aligning the package metadata and changelog with the project's current pre-release status.
Changes:
- Upgraded bilingual README files (
README.md,README.tr.md) with goal-oriented navigation, status banners, ToC, and hyperlinked cross-references replacing plain paths - Added new English and Turkish guides:
release-guide.md,governance-guide.md,surum-yayin-rehberi.md,yonetisim-rehberi.md - Updated
package.jsonmetadata (proper repository URL format,bugs,homepage,engines,publishConfig, and additional distributed files)
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
package.json |
Adds standard npm fields: bugs, homepage, engines, publishConfig, corrects repository URL format, and includes README.tr.md/CHANGELOG.md in published files |
CHANGELOG.md |
Adds [Unreleased] section above [0.1.0] to document this PR's doc changes |
README.md |
Major overhaul: new sections with emoji headings, status banner, ToC, hyperlinked doc map, and pre-release installation note |
README.tr.md |
Turkish counterpart of README.md overhaul, kept in sync with English version |
docs/README.md |
Restructured into goal-oriented navigation with full bilingual coverage and Quick Navigation section |
docs/ARCHITECTURE.md |
Adds a Table of Contents pointing to existing sections |
docs/en/usage-guide.md |
Restructured into numbered sections, pre-release note added, "Day-To-Day Commands" section added |
docs/en/release-guide.md |
New file: step-by-step release process and pre-release checklist |
docs/en/governance-guide.md |
New file: branch protection rules, merge policy, and automation inventory |
docs/en/pull-request-guide.md |
Adds "Related Docs" section with hyperlinks |
docs/en/model-recommendations.md |
Adds "Recommended Starting Point" and "Related Docs" sections |
docs/tr/kullanim-kilavuzu.md |
Turkish usage guide restructured to match English counterpart |
docs/tr/surum-yayin-rehberi.md |
New Turkish release guide, mirrors docs/en/release-guide.md |
docs/tr/yonetisim-rehberi.md |
New Turkish governance guide, mirrors docs/en/governance-guide.md |
docs/tr/pr-kilavuzu.md |
Adds "Ilgili Dokumanlar" section with hyperlinks |
docs/tr/model-onerileri.md |
Adds "Onerilen Baslangic Noktasi" and "Ilgili Dokumanlar" sections |
CONTRIBUTING.md |
Adds "Repository Reality" context and upgrades "Further Reading" to hyperlinks |
CODE_OF_CONDUCT.md |
Reporting section reformatted as numbered steps |
SECURITY.md |
Reporting instructions clarified, related docs upgraded to hyperlinks |
SUPPORT.md |
Adds bug report guidance and upgrades references to hyperlinks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Ilgili Dokumanlar | ||
|
|
||
| - [Kullanim Kilavuzu](./kullanim-kilavuzu.md) | ||
| - [Surum ve Yayin Rehberi](./surum-yayin-rehberi.md) |
There was a problem hiding this comment.
The "Ilgili Dokumanlar" section links to [Surum ve Yayin Rehberi] (Release Guide), which is unrelated to model recommendations. A more relevant linked document would be something like the PR guide or Architecture document. This mirrors the same issue in the English counterpart (docs/en/model-recommendations.md).
| ## [Unreleased] | ||
|
|
||
| ### Docs | ||
|
|
||
| - Strengthened the bilingual documentation system with direct links, release guidance, governance guidance, and clearer usage flows. | ||
| - Clarified that npm publication and the first GitHub release have not happened yet. | ||
|
|
||
| ## [0.1.0] - 2026-03-09 |
There was a problem hiding this comment.
The CHANGELOG has [0.1.0] - 2026-03-09 as a formal dated release entry (following Keep a Changelog conventions, where a dated entry typically indicates a published release), but the new [Unreleased] section immediately above it, along with multiple documentation files, explicitly states that npm publication has not happened yet. In Keep a Changelog format, a dated version entry implies it has been released. If 0.1.0 has not been published to npm, the [0.1.0] - 2026-03-09 entry should either remain as [Unreleased] or its date should be removed to avoid confusion.
| @@ -0,0 +1,36 @@ | |||
| # Yonetsim ve Branch Politikasi | |||
There was a problem hiding this comment.
The filename yonetisim-rehberi.md contains "yonetisim" (with the extra 'i'), but the document's heading and all link display text consistently use "Yonetsim" (without the extra 'i'): for example, the heading in the file itself is # Yonetsim ve Branch Politikasi. This naming discrepancy between the filename and the document title could cause confusion. The filename should be aligned with the content's heading — either rename the file to yonetsim-rehberi.md and update all links, or update the heading and link text to "Yonetisim".
| 4. Repo GitHub icin hazirsa branch ve PR teslimati da otomatiklestirilebilir. | ||
|
|
||
| ## Onerilen Yerel Akis | ||
| ## 6. Guncelik Komutlar |
There was a problem hiding this comment.
The section heading "Guncelik Komutlar" is not standard Turkish. The English equivalent is "Day-To-Day Commands", which would more correctly translate to "Gunluk Komutlar" ("günlük" meaning "daily" or "day-to-day") rather than "Guncelik". "Guncelik" is not a recognized Turkish word.
| - [Usage Guide](./usage-guide.md) | ||
| - [Release Guide](./release-guide.md) |
There was a problem hiding this comment.
The "Related Docs" section in the model recommendations guide links to the Release Guide, but these two topics are unrelated — model tuning preferences have no connection to the release process. A more useful related document here would be something like the PR Guide or the Architecture document. The equivalent Turkish document (docs/tr/model-onerileri.md) has the same issue on its last line.
Summary
Verification