Fix links to documentation - #515
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new yiisoft.github.io/docs URLs are inconsistent with the repo’s existing .html link format and the change also conflicts with the review’s documented constraint limiting edits to src/{cookbook,guide,internals}.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the contributor documentation to point readers to the rendered Yii3 docs site instead of GitHub blob/master links.
Changes:
- Replaced prerequisites links with
yiisoft.github.io/docs/internals/...URLs. - Updated “special development tool” and “roadmap” links to the same docs domain.
File summaries
| File | Description |
|---|---|
| .github/CONTRIBUTING.md | Updates documentation links in contributor instructions to the published docs site. |
Review details
Suppressed comments (2)
.github/CONTRIBUTING.md:21
- This roadmap link omits the
.htmlsuffix, while mostyiisoft.github.io/docslinks in the repo include it. Adding.htmlwould keep link formatting consistent and reduce the chance of a GitHub Pages 404.
- [Check roadmap](https://yiisoft.github.io/docs/internals/003-roadmap).
.github/CONTRIBUTING.md:11
- This link omits the
.htmlsuffix, but other references to the published docs in this repo use.html(e.g.,README.md:27). Consider adding.htmlhere to avoid potential GitHub Pages 404s and keep link format consistent.
Since Yii 3 consists of many packages, we have a [special development tool](https://yiisoft.github.io/docs/internals/005-development-tool).
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+3
to
+7
| - [Yii goal and values](https://yiisoft.github.io/docs/internals/001-yii-values) | ||
| - [Namespaces](https://yiisoft.github.io/docs/internals/004-namespaces) | ||
| - [Git commit messages](https://yiisoft.github.io/docs/internals/006-git-commit-messages) | ||
| - [Exceptions](https://yiisoft.github.io/docs/internals/007-exceptions) | ||
| - [Interfaces](https://yiisoft.github.io/docs/internals/008-interfaces) |
| - [Git commit messages](https://github.com/yiisoft/docs/blob/master/006-git-commit-messages.md) | ||
| - [Exceptions](https://github.com/yiisoft/docs/blob/master/007-exceptions.md) | ||
| - [Interfaces](https://github.com/yiisoft/docs/blob/master/008-interfaces.md) | ||
| - [Yii goal and values](https://yiisoft.github.io/docs/internals/001-yii-values) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.